Apache NiFi REST API

REST API definition for Apache NiFi 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.nifi.apis.flow_file_queues_api.FlowFileQueuesApi(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_drop_request(id, **kwargs)[source]

Creates a request to drop the contents of the queue in this connection.. 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_drop_request_with_http_info() method instead.

Parameters:

id (str) – The connection id. (required)

Returns:

The response data.

Return type:

DropRequestEntity

create_drop_request_with_http_info(id, **kwargs)[source]

Creates a request to drop the contents of the queue in this connection.. 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_drop_request() method instead.

Parameters:

id (str) – The connection id. (required)

Returns:

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

Return type:

tuple

create_flow_file_listing(id, **kwargs)[source]

Lists the contents of the queue in this connection.. 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_file_listing_with_http_info() method instead.

Parameters:

id (str) – The connection id. (required)

Returns:

The response data.

Return type:

ListingRequestEntity

create_flow_file_listing_with_http_info(id, **kwargs)[source]

Lists the contents of the queue in this connection.. 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_file_listing() method instead.

Parameters:

id (str) – The connection id. (required)

Returns:

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

Return type:

tuple

delete_listing_request(id, listing_request_id, **kwargs)[source]

Cancels and/or removes a request to list the contents of this connection.. 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_listing_request_with_http_info() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • listing_request_id (str) – The listing request id. (required)

Returns:

The response data.

Return type:

ListingRequestEntity

delete_listing_request_with_http_info(id, listing_request_id, **kwargs)[source]

Cancels and/or removes a request to list the contents of this connection.. 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_listing_request() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • listing_request_id (str) – The listing request id. (required)

Returns:

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

Return type:

tuple

download_flow_file_content(id, flowfile_uuid, **kwargs)[source]

Gets the content for a FlowFile in a Connection.. 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 download_flow_file_content_with_http_info() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • flowfile_uuid (str) – The flowfile uuid. (required)

  • range (str) – Range of bytes requested

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

  • cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

The response data.

Return type:

StreamingOutput

download_flow_file_content_with_http_info(id, flowfile_uuid, **kwargs)[source]

Gets the content for a FlowFile in a Connection.. 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 download_flow_file_content() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • flowfile_uuid (str) – The flowfile uuid. (required)

  • range (str) – Range of bytes requested

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

  • cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

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

Return type:

tuple

get_drop_request(id, drop_request_id, **kwargs)[source]

Gets the current status of a drop request for the specified connection.. 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_drop_request_with_http_info() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

The response data.

Return type:

DropRequestEntity

get_drop_request_with_http_info(id, drop_request_id, **kwargs)[source]

Gets the current status of a drop request for the specified connection.. 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_drop_request() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

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

Return type:

tuple

get_flow_file(id, flowfile_uuid, **kwargs)[source]

Gets a FlowFile from a Connection.. 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_file_with_http_info() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • flowfile_uuid (str) – The flowfile uuid. (required)

  • cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

The response data.

Return type:

FlowFileEntity

get_flow_file_with_http_info(id, flowfile_uuid, **kwargs)[source]

Gets a FlowFile from a Connection.. 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_file() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • flowfile_uuid (str) – The flowfile uuid. (required)

  • cluster_node_id (str) – The id of the node where the content exists if clustered.

Returns:

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

Return type:

tuple

get_listing_request(id, listing_request_id, **kwargs)[source]

Gets the current status of a listing request for the specified connection.. 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_listing_request_with_http_info() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • listing_request_id (str) – The listing request id. (required)

Returns:

The response data.

Return type:

ListingRequestEntity

get_listing_request_with_http_info(id, listing_request_id, **kwargs)[source]

Gets the current status of a listing request for the specified connection.. 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_listing_request() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • listing_request_id (str) – The listing request id. (required)

Returns:

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

Return type:

tuple

remove_drop_request(id, drop_request_id, **kwargs)[source]

Cancels and/or removes a request to drop the contents of this connection.. 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 remove_drop_request_with_http_info() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

The response data.

Return type:

DropRequestEntity

remove_drop_request_with_http_info(id, drop_request_id, **kwargs)[source]

Cancels and/or removes a request to drop the contents of this connection.. 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 remove_drop_request() method instead.

Parameters:

  • id (str) – The connection id. (required)

  • drop_request_id (str) – The drop request id. (required)

Returns:

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

Return type:

tuple