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.extension_repository_api.ExtensionRepositoryApi(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_extension_repo_artifacts(bucket_name, group_id, **kwargs)[source]

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

Parameters:

  • bucket_name (str) – The bucket name (required)

  • group_id (str) – The group id (required)

Returns:

The response data.

Return type:

list[ExtensionRepoArtifact]

get_extension_repo_artifacts_with_http_info(bucket_name, group_id, **kwargs)[source]

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

Parameters:

  • bucket_name (str) – The bucket name (required)

  • group_id (str) – The group id (required)

Returns:

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

Return type:

tuple

get_extension_repo_buckets(**kwargs)[source]

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

The response data.

Return type:

list[ExtensionRepoBucket]

get_extension_repo_buckets_with_http_info(**kwargs)[source]

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

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

Return type:

tuple

get_extension_repo_groups(bucket_name, **kwargs)[source]

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

Parameters:

bucket_name (str) – The bucket name (required)

Returns:

The response data.

Return type:

list[ExtensionRepoGroup]

get_extension_repo_groups_with_http_info(bucket_name, **kwargs)[source]

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

Parameters:

bucket_name (str) – The bucket name (required)

Returns:

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

Return type:

tuple

get_extension_repo_version(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

The response data.

Return type:

ExtensionRepoVersion

get_extension_repo_version_content(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

The response data.

Return type:

str

get_extension_repo_version_content_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

Return type:

tuple

get_extension_repo_version_extension(bucket_name, group_id, artifact_id, version, name, **kwargs)[source]

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

Parameters:

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

The response data.

Return type:

Extension

get_extension_repo_version_extension_additional_details_docs(bucket_name, group_id, artifact_id, version, name, **kwargs)[source]

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

Parameters:

  • 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

get_extension_repo_version_extension_additional_details_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs)[source]

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

Parameters:

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

Return type:

tuple

get_extension_repo_version_extension_docs(bucket_name, group_id, artifact_id, version, name, **kwargs)[source]

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

Parameters:

  • 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

get_extension_repo_version_extension_docs_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs)[source]

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

Parameters:

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

Return type:

tuple

get_extension_repo_version_extension_with_http_info(bucket_name, group_id, artifact_id, version, name, **kwargs)[source]

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

Parameters:

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

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

Return type:

tuple

get_extension_repo_version_extensions(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

The response data.

Return type:

list[ExtensionMetadata]

get_extension_repo_version_extensions_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

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

Return type:

tuple

get_extension_repo_version_sha256(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

  • 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

get_extension_repo_version_sha256_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

Return type:

tuple

get_extension_repo_version_with_http_info(bucket_name, group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

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

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

Return type:

tuple

get_extension_repo_versions(bucket_name, group_id, artifact_id, **kwargs)[source]

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

Parameters:

  • bucket_name (str) – The bucket name (required)

  • group_id (str) – The group identifier (required)

  • artifact_id (str) – The artifact identifier (required)

Returns:

The response data.

Return type:

list[ExtensionRepoVersionSummary]

get_extension_repo_versions_with_http_info(bucket_name, group_id, artifact_id, **kwargs)[source]

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

Parameters:

  • bucket_name (str) – The bucket name (required)

  • group_id (str) – The group identifier (required)

  • artifact_id (str) – The artifact identifier (required)

Returns:

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

Return type:

tuple

get_global_extension_repo_version_sha256(group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

  • group_id (str) – The group identifier (required)

  • artifact_id (str) – The artifact identifier (required)

  • version (str) – The version (required)

Returns:

None

get_global_extension_repo_version_sha256_with_http_info(group_id, artifact_id, version, **kwargs)[source]

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

Parameters:

  • group_id (str) – The group identifier (required)

  • artifact_id (str) – The artifact identifier (required)

  • version (str) – The version (required)

Returns:

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

Return type:

tuple