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.flows_api.FlowsApi(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_available_flow_fields(**kwargs)[source]

Get flow fields.

Retrieves the flow field names that can be used for searching or sorting on flows.

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_available_flow_fields_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

Fields

get_available_flow_fields_with_http_info(**kwargs)[source]

Get flow fields.

Retrieves the flow field names that can be used for searching or sorting on flows.

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_available_flow_fields() method instead.

Args:

Returns:

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

Return type:

tuple

get_flow1(flow_id, **kwargs)[source]

Get flow.

Gets a flow by id.

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_flow1_with_http_info() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlow

get_flow1_with_http_info(flow_id, **kwargs)[source]

Get flow.

Gets a flow by id.

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_flow1() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

get_flow_version1(flow_id, version_number, **kwargs)[source]

Get flow version.

Gets the given version of a flow, including metadata and flow content.

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_version1_with_http_info() method instead.

Parameters:

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

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

Returns:

The response data.

Return type:

VersionedFlowSnapshot

get_flow_version1_with_http_info(flow_id, version_number, **kwargs)[source]

Get flow version.

Gets the given version of a flow, including metadata and flow content.

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_version1() method instead.

Parameters:

  • 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_versions1(flow_id, **kwargs)[source]

Get flow versions.

Gets summary information for all versions of a given 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_versions1_with_http_info() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

list[VersionedFlowSnapshotMetadata]

get_flow_versions1_with_http_info(flow_id, **kwargs)[source]

Get flow versions.

Gets summary information for all versions of a given 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_versions1() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

get_latest_flow_version1(flow_id, **kwargs)[source]

Get latest flow version.

Gets the latest version of a flow, including metadata and flow content.

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_version1_with_http_info() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlowSnapshot

get_latest_flow_version1_with_http_info(flow_id, **kwargs)[source]

Get latest flow version.

Gets the latest version of a flow, including metadata and flow content.

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_version1() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple

get_latest_flow_version_metadata1(flow_id, **kwargs)[source]

Get latest 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_metadata1_with_http_info() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

The response data.

Return type:

VersionedFlowSnapshotMetadata

get_latest_flow_version_metadata1_with_http_info(flow_id, **kwargs)[source]

Get latest 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_metadata1() method instead.

Parameters:

flow_id (str) – The flow identifier (required)

Returns:

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

Return type:

tuple