Apache NiFi Registry REST API

REST API definition for Apache NiFi Registry web services

OpenAPI spec version: 2.6.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.registry.apis.bundles_api.BundlesApi(api_client=None)[source]

Bases: object

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

__init__(api_client=None)[source]
delete_bundle(bundle_id, **kwargs)[source]

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.

Parameters:

bundle_id (str) – The extension bundle identifier (required)

Returns:

The response data.

Return type:

Bundle

delete_bundle_version(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

The response data.

Return type:

BundleVersion

delete_bundle_version_with_http_info(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

(BundleVersion, status_code, headers) - Response data with HTTP details.

Return type:

tuple

delete_bundle_with_http_info(bundle_id, **kwargs)[source]

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.

Parameters:

bundle_id (str) – The extension bundle identifier (required)

Returns:

(Bundle, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle(bundle_id, **kwargs)[source]

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.

Parameters:

bundle_id (str) – The extension bundle identifier (required)

Returns:

The response data.

Return type:

Bundle

get_bundle_version(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

The response data.

Return type:

BundleVersion

get_bundle_version_content(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

The response data.

Return type:

str

get_bundle_version_content_with_http_info(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

(str, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_version_extension(bundle_id, version, name, **kwargs)[source]

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.

Parameters:

  • 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:

The response data.

Return type:

list[Extension]

get_bundle_version_extension_additional_details_docs(bundle_id, version, name, **kwargs)[source]

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.

Parameters:

  • 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

get_bundle_version_extension_additional_details_docs_with_http_info(bundle_id, version, name, **kwargs)[source]

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.

Parameters:

  • 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, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_version_extension_docs(bundle_id, version, name, **kwargs)[source]

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.

Parameters:

  • 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

get_bundle_version_extension_docs_with_http_info(bundle_id, version, name, **kwargs)[source]

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.

Parameters:

  • 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, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_version_extension_with_http_info(bundle_id, version, name, **kwargs)[source]

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.

Parameters:

  • 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:

(list[Extension], status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_version_extensions(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

The response data.

Return type:

list[ExtensionMetadata]

get_bundle_version_extensions_with_http_info(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

(list[ExtensionMetadata], status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_version_with_http_info(bundle_id, version, **kwargs)[source]

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.

Parameters:

  • bundle_id (str) – The extension bundle identifier (required)

  • version (str) – The version of the bundle (required)

Returns:

(BundleVersion, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_versions(bundle_id, **kwargs)[source]

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.

Parameters:

bundle_id (str) – The extension bundle identifier (required)

Returns:

The response data.

Return type:

list[BundleVersionMetadata]

get_bundle_versions1(**kwargs)[source]

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.

Parameters:

  • 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:

The response data.

Return type:

list[BundleVersionMetadata]

get_bundle_versions1_with_http_info(**kwargs)[source]

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.

Parameters:

  • 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:

(list[BundleVersionMetadata], status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_versions_with_http_info(bundle_id, **kwargs)[source]

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.

Parameters:

bundle_id (str) – The extension bundle identifier (required)

Returns:

(list[BundleVersionMetadata], status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundle_with_http_info(bundle_id, **kwargs)[source]

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.

Parameters:

bundle_id (str) – The extension bundle identifier (required)

Returns:

(Bundle, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bundles(**kwargs)[source]

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.

Parameters:

  • 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:

The response data.

Return type:

list[Bundle]

get_bundles_with_http_info(**kwargs)[source]

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.

Parameters:

  • 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:

(list[Bundle], status_code, headers) - Response data with HTTP details.

Return type:

tuple