Apache NiFi REST API

REST API definition for Apache NiFi 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.nifi.apis.data_transfer_api.DataTransferApi(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]
commit_input_port_transaction(response_code, port_id, transaction_id, **kwargs)[source]

Commit or cancel the specified transaction. 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 commit_input_port_transaction_with_http_info() method instead.

Parameters:

  • response_code (int) – The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)

  • port_id (str) – The input port id. (required)

  • transaction_id (str) – The transaction id. (required)

  • body (object)

Returns:

The response data.

Return type:

TransactionResultEntity

commit_input_port_transaction_with_http_info(response_code, port_id, transaction_id, **kwargs)[source]

Commit or cancel the specified transaction. 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 commit_input_port_transaction() method instead.

Parameters:

  • response_code (int) – The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)

  • port_id (str) – The input port id. (required)

  • transaction_id (str) – The transaction id. (required)

  • body (object)

Returns:

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

Return type:

tuple

commit_output_port_transaction(response_code, checksum, port_id, transaction_id, **kwargs)[source]

Commit or cancel the specified transaction. 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 commit_output_port_transaction_with_http_info() method instead.

Parameters:

  • response_code (int) – The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)

  • checksum (str) – A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required)

  • port_id (str) – The output port id. (required)

  • transaction_id (str) – The transaction id. (required)

  • body (object)

Returns:

The response data.

Return type:

TransactionResultEntity

commit_output_port_transaction_with_http_info(response_code, checksum, port_id, transaction_id, **kwargs)[source]

Commit or cancel the specified transaction. 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 commit_output_port_transaction() method instead.

Parameters:

  • response_code (int) – The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15). (required)

  • checksum (str) – A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side. (required)

  • port_id (str) – The output port id. (required)

  • transaction_id (str) – The transaction id. (required)

  • body (object)

Returns:

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

Return type:

tuple

create_port_transaction(port_type, port_id, **kwargs)[source]

Create a transaction to the specified output port or input port. 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_port_transaction_with_http_info() method instead.

Parameters:

  • port_type (str) – The port type. (required)

  • port_id (str) – (required)

  • body (object)

Returns:

The response data.

Return type:

TransactionResultEntity

create_port_transaction_with_http_info(port_type, port_id, **kwargs)[source]

Create a transaction to the specified output port or input port. 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_port_transaction() method instead.

Parameters:

  • port_type (str) – The port type. (required)

  • port_id (str) – (required)

  • body (object)

Returns:

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

Return type:

tuple

extend_input_port_transaction_ttl(port_id, transaction_id, **kwargs)[source]

Extend transaction TTL. 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 extend_input_port_transaction_ttl_with_http_info() method instead.

Parameters:

  • port_id (str) – (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

The response data.

Return type:

TransactionResultEntity

extend_input_port_transaction_ttl_with_http_info(port_id, transaction_id, **kwargs)[source]

Extend transaction TTL. 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 extend_input_port_transaction_ttl() method instead.

Parameters:

  • port_id (str) – (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

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

Return type:

tuple

extend_output_port_transaction_ttl(port_id, transaction_id, **kwargs)[source]

Extend transaction TTL. 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 extend_output_port_transaction_ttl_with_http_info() method instead.

Parameters:

  • port_id (str) – (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

The response data.

Return type:

TransactionResultEntity

extend_output_port_transaction_ttl_with_http_info(port_id, transaction_id, **kwargs)[source]

Extend transaction TTL. 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 extend_output_port_transaction_ttl() method instead.

Parameters:

  • port_id (str) – (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

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

Return type:

tuple

receive_flow_files(port_id, transaction_id, **kwargs)[source]

Transfer flow files to the input port. 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 receive_flow_files_with_http_info() method instead.

Parameters:

  • port_id (str) – The input port id. (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

The response data.

Return type:

str

receive_flow_files_with_http_info(port_id, transaction_id, **kwargs)[source]

Transfer flow files to the input port. 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 receive_flow_files() method instead.

Parameters:

  • port_id (str) – The input port id. (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

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

Return type:

tuple

transfer_flow_files(port_id, transaction_id, **kwargs)[source]

Transfer flow files from the output port. 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 transfer_flow_files_with_http_info() method instead.

Parameters:

  • port_id (str) – The output port id. (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

None

transfer_flow_files_with_http_info(port_id, transaction_id, **kwargs)[source]

Transfer flow files from the output port. 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 transfer_flow_files() method instead.

Parameters:

  • port_id (str) – The output port id. (required)

  • transaction_id (str) – (required)

  • body (object)

Returns:

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

Return type:

tuple