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.extensions_api.ExtensionsApi(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]
get_extensions(**kwargs)[source]

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 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.

Parameters:

  • bundle_type (str) – The type of bundles to return

  • extension_type (str) – The type of extensions to return

  • tag (list[str]) – The tags to filter on, will be used in an OR statement

Returns:

The response data.

Return type:

ExtensionMetadataContainer

get_extensions_providing_service_api(class_name, group_id, artifact_id, version, **kwargs)[source]

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 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.

Parameters:

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

The response data.

Return type:

ExtensionMetadataContainer

get_extensions_providing_service_api_with_http_info(class_name, group_id, artifact_id, version, **kwargs)[source]

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 and returns 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.

Parameters:

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

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

Return type:

tuple

get_extensions_with_http_info(**kwargs)[source]

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 and returns 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.

Parameters:

  • bundle_type (str) – The type of bundles to return

  • extension_type (str) – The type of extensions to return

  • tag (list[str]) – The tags to filter on, will be used in an OR statement

Returns:

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

Return type:

tuple

get_tags(**kwargs)[source]

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

The response data.

Return type:

list[TagCount]

get_tags_with_http_info(**kwargs)[source]

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 and returns 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:

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

Return type:

tuple