Apache NiFi Registry REST API

REST API definition for Apache NiFi Registry web services

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

class nipyapi.registry.apis.bucket_bundles_api.BucketBundlesApi(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]
create_extension_bundle_version(bucket_id, bundle_type, **kwargs)[source]

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

Parameters:
Returns:

The response data.

Return type:

BundleVersion

create_extension_bundle_version_with_http_info(bucket_id, bundle_type, **kwargs)[source]

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

Parameters:
Returns:

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

Return type:

tuple

get_extension_bundles(bucket_id, **kwargs)[source]

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

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

The response data.

Return type:

list[Bundle]

get_extension_bundles_with_http_info(bucket_id, **kwargs)[source]

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

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

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

Return type:

tuple