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.bucket_flows_api.BucketFlowsApi(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_flow(body, bucket_id, **kwargs)[source]

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

Parameters:

  • body (VersionedFlow) – The details of the flow to create. (required)

  • bucket_id (str) – The bucket identifier (required)

Returns:

The response data.

Return type:

VersionedFlow

create_flow_version(body, bucket_id, flow_id, **kwargs)[source]

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

Parameters:

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

The response data.

Return type:

VersionedFlowSnapshot

create_flow_version_with_http_info(body, bucket_id, flow_id, **kwargs)[source]

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

Parameters:

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

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

Return type:

tuple

create_flow_with_http_info(body, bucket_id, **kwargs)[source]

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

Parameters:

  • body (VersionedFlow) – The details of the flow to create. (required)

  • bucket_id (str) – The bucket identifier (required)

Returns:

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

Return type:

tuple

delete_flow(version, bucket_id, flow_id, **kwargs)[source]

Delete bucket flow.

Deletes a flow, including all saved versions of that flow.

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

Parameters:

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

The response data.

Return type:

VersionedFlow

delete_flow_with_http_info(version, bucket_id, flow_id, **kwargs)[source]

Delete bucket flow.

Deletes a flow, including all saved versions of that flow.

This method makes a synchronous HTTP request and returns 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.

Parameters:

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

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

Return type:

tuple

export_versioned_flow(bucket_id, flow_id, version_number, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

  • version_number (int) – The version number (required)

Returns:

The response data.

Return type:

VersionedFlowSnapshot

export_versioned_flow_with_http_info(bucket_id, flow_id, version_number, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

  • version_number (int) – The version number (required)

Returns:

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

Return type:

tuple

get_flow(bucket_id, flow_id, **kwargs)[source]

Get bucket flow.

Retrieves the flow with the given id in the given 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 get_flow_with_http_info() method instead.

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlow

get_flow_diff(bucket_id, flow_id, version_a, version_b, **kwargs)[source]

Get bucket flow diff.

Computes the differences between two given versions of a flow.

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

Parameters:

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

The response data.

Return type:

VersionedFlowDifference

get_flow_diff_with_http_info(bucket_id, flow_id, version_a, version_b, **kwargs)[source]

Get bucket flow diff.

Computes the differences between two given versions of a flow.

This method makes a synchronous HTTP request and returns 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.

Parameters:

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

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

Return type:

tuple

get_flow_version(bucket_id, flow_id, version_number, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

  • version_number (int) – The version number (required)

Returns:

The response data.

Return type:

VersionedFlowSnapshot

get_flow_version_with_http_info(bucket_id, flow_id, version_number, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

  • version_number (int) – The version number (required)

Returns:

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

Return type:

tuple

get_flow_versions(bucket_id, flow_id, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

list[VersionedFlowSnapshotMetadata]

get_flow_versions_with_http_info(bucket_id, flow_id, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

get_flow_with_http_info(bucket_id, flow_id, **kwargs)[source]

Get bucket flow.

Retrieves the flow with the given id in the given 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 get_flow() method instead.

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

get_flows(bucket_id, **kwargs)[source]

Get bucket flows.

Retrieves all flows in the given 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 get_flows_with_http_info() method instead.

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

The response data.

Return type:

list[VersionedFlow]

get_flows_with_http_info(bucket_id, **kwargs)[source]

Get bucket flows.

Retrieves all flows in the given 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 get_flows() method instead.

Parameters:

bucket_id (str) – The bucket identifier (required)

Returns:

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

Return type:

tuple

get_latest_flow_version(bucket_id, flow_id, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlowSnapshot

get_latest_flow_version_metadata(bucket_id, flow_id, **kwargs)[source]

Get latest bucket flow version metadata.

Gets the metadata for the latest version of a flow.

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlowSnapshotMetadata

get_latest_flow_version_metadata_with_http_info(bucket_id, flow_id, **kwargs)[source]

Get latest bucket flow version metadata.

Gets the metadata for the latest version of a flow.

This method makes a synchronous HTTP request and returns 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.

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

get_latest_flow_version_with_http_info(bucket_id, flow_id, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

import_versioned_flow(bucket_id, flow_id, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

  • body (VersionedFlowSnapshot) – file

  • comments (str)

Returns:

The response data.

Return type:

VersionedFlowSnapshot

import_versioned_flow_with_http_info(bucket_id, flow_id, **kwargs)[source]

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

Parameters:

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

  • body (VersionedFlowSnapshot) – file

  • comments (str)

Returns:

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

Return type:

tuple

update_flow(body, bucket_id, flow_id, **kwargs)[source]

Update bucket flow.

Updates the flow with the given id in the given 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 update_flow_with_http_info() method instead.

Parameters:

  • body (VersionedFlow) – The updated flow (required)

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlow

update_flow_with_http_info(body, bucket_id, flow_id, **kwargs)[source]

Update bucket flow.

Updates the flow with the given id in the given 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 update_flow() method instead.

Parameters:

  • body (VersionedFlow) – The updated flow (required)

  • bucket_id (str) – The bucket identifier (required)

  • flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple