nipyapi.nifi.apis package

Submodules

nipyapi.nifi.apis.access_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.access_api.AccessApi(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

create_access_token(**kwargs)[source]

Creates a token for accessing the REST API via username/password The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • username (str) –

  • password (str) –

Returns:

str If the method is called asynchronously, returns the request thread.

create_access_token_from_ticket(**kwargs)[source]

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. It is also stored in the browser as a cookie. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_from_ticket(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

str If the method is called asynchronously, returns the request thread.

create_access_token_from_ticket_with_http_info(**kwargs)[source]

Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format ‘Authorization: Bearer <token>’. It is also stored in the browser as a cookie. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_from_ticket_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

str If the method is called asynchronously, returns the request thread.

create_access_token_with_http_info(**kwargs)[source]

Creates a token for accessing the REST API via username/password The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. It is stored in the browser as a cookie, but also returned inthe response body to be stored/used by third party client scripts. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_token_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • username (str) –

  • password (str) –

Returns:

str If the method is called asynchronously, returns the request thread.

get_access_status(**kwargs)[source]

Gets the status the client’s access Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AccessStatusEntity If the method is called asynchronously, returns the request thread.

get_access_status_with_http_info(**kwargs)[source]

Gets the status the client’s access Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_status_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AccessStatusEntity If the method is called asynchronously, returns the request thread.

get_access_token_expiration(**kwargs)[source]

Get expiration for current Access Token Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_token_expiration(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AccessTokenExpirationEntity If the method is called asynchronously, returns the request thread.

get_access_token_expiration_with_http_info(**kwargs)[source]

Get expiration for current Access Token Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_token_expiration_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AccessTokenExpirationEntity If the method is called asynchronously, returns the request thread.

get_login_config(**kwargs)[source]

Retrieves the access configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_login_config(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AccessConfigurationEntity If the method is called asynchronously, returns the request thread.

get_login_config_with_http_info(**kwargs)[source]

Retrieves the access configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_login_config_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AccessConfigurationEntity If the method is called asynchronously, returns the request thread.

knox_callback(**kwargs)[source]

Redirect/callback URI for processing the result of the Apache Knox login sequence. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_callback(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

knox_callback_with_http_info(**kwargs)[source]

Redirect/callback URI for processing the result of the Apache Knox login sequence. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_callback_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

knox_logout(**kwargs)[source]

Performs a logout in the Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_logout(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

knox_logout_with_http_info(**kwargs)[source]

Performs a logout in the Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_logout_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

knox_request(**kwargs)[source]

Initiates a request to authenticate through Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_request(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

knox_request_with_http_info(**kwargs)[source]

Initiates a request to authenticate through Apache Knox. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.knox_request_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

log_out(**kwargs)[source]

Performs a logout for other providers that have been issued a JWT. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

log_out_complete(**kwargs)[source]

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_complete(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

log_out_complete_with_http_info(**kwargs)[source]

Completes the logout sequence by removing the cached Logout Request and Cookie if they existed and redirects to /nifi/login. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_complete_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

log_out_with_http_info(**kwargs)[source]

Performs a logout for other providers that have been issued a JWT. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.log_out_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

None If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.connections_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.connections_api.ConnectionsApi(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

delete_connection(id, **kwargs)[source]

Deletes a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_connection(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

delete_connection_with_http_info(id, **kwargs)[source]

Deletes a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_connection_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

get_connection(id, **kwargs)[source]

Gets a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

get_connection_with_http_info(id, **kwargs)[source]

Gets a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

update_connection(id, body, **kwargs)[source]

Updates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_connection(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

update_connection_with_http_info(id, body, **kwargs)[source]

Updates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_connection_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.controller_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.controller_api.ControllerApi(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

create_bulletin(body, **kwargs)[source]

Creates a new bulletin

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bulletin(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (BulletinEntity) – The reporting task configuration details. (required)

Returns:

BulletinEntity If the method is called asynchronously, returns the request thread.

create_bulletin_with_http_info(body, **kwargs)[source]

Creates a new bulletin

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_bulletin_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (BulletinEntity) – The reporting task configuration details. (required)

Returns:

BulletinEntity If the method is called asynchronously, returns the request thread.

create_controller_service(body, **kwargs)[source]

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_controller_service_with_http_info(body, **kwargs)[source]

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_flow_registry_client(body, **kwargs)[source]

Creates a new flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_registry_client(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

create_flow_registry_client_with_http_info(body, **kwargs)[source]

Creates a new flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_registry_client_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

create_parameter_provider(body, **kwargs)[source]

Creates a new parameter provider

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_parameter_provider(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ParameterProviderEntity) – The parameter provider configuration details. (required)

Returns:

ParameterProviderEntity If the method is called asynchronously, returns the request thread.

create_parameter_provider_with_http_info(body, **kwargs)[source]

Creates a new parameter provider

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_parameter_provider_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ParameterProviderEntity) – The parameter provider configuration details. (required)

Returns:

ParameterProviderEntity If the method is called asynchronously, returns the request thread.

create_reporting_task(body, **kwargs)[source]

Creates a new reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_reporting_task(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

create_reporting_task_with_http_info(body, **kwargs)[source]

Creates a new reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_reporting_task_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

delete_flow_registry_client(id, **kwargs)[source]

Deletes a flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_flow_registry_client(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

delete_flow_registry_client_with_http_info(id, **kwargs)[source]

Deletes a flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_flow_registry_client_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

delete_history(end_date, **kwargs)[source]

Purges history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_history(end_date, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • end_date (str) – Purge actions before this date/time. (required)

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

delete_history_with_http_info(end_date, **kwargs)[source]

Purges history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_history_with_http_info(end_date, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • end_date (str) – Purge actions before this date/time. (required)

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

delete_node(id, **kwargs)[source]

Removes a node from the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_node(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

delete_node_with_http_info(id, **kwargs)[source]

Removes a node from the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_node_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

get_cluster(**kwargs)[source]

Gets the contents of the cluster Returns the contents of the cluster including all nodes and their status. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ClusterEntity If the method is called asynchronously, returns the request thread.

get_cluster_with_http_info(**kwargs)[source]

Gets the contents of the cluster Returns the contents of the cluster including all nodes and their status. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ClusterEntity If the method is called asynchronously, returns the request thread.

get_controller_config(**kwargs)[source]

Retrieves the configuration for this NiFi Controller

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_config(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

get_controller_config_with_http_info(**kwargs)[source]

Retrieves the configuration for this NiFi Controller

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_config_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

get_flow_registry_client(id, **kwargs)[source]

Gets a flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_registry_client(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

get_flow_registry_client_with_http_info(id, **kwargs)[source]

Gets a flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_registry_client_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

get_flow_registry_clients(**kwargs)[source]

Gets the listing of available flow registry clients

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_registry_clients(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowRegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_flow_registry_clients_with_http_info(**kwargs)[source]

Gets the listing of available flow registry clients

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_registry_clients_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowRegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_node(id, **kwargs)[source]

Gets a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

get_node_status_history(**kwargs)[source]

Gets status history for the node Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node_status_history(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_node_status_history_with_http_info(**kwargs)[source]

Gets status history for the node Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node_status_history_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_node_with_http_info(id, **kwargs)[source]

Gets a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_node_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)[source]

Gets a flow registry client property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

  • property_name (str) – The property name. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)[source]

Gets a flow registry client property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

  • property_name (str) – The property name. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_registry_client_types(**kwargs)[source]

Retrieves the types of flow that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_client_types(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowRegistryClientTypesEntity If the method is called asynchronously, returns the request thread.

get_registry_client_types_with_http_info(**kwargs)[source]

Retrieves the types of flow that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_client_types_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowRegistryClientTypesEntity If the method is called asynchronously, returns the request thread.

update_controller_config(body, **kwargs)[source]

Retrieves the configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_config(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ControllerConfigurationEntity) – The controller configuration. (required)

Returns:

ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

update_controller_config_with_http_info(body, **kwargs)[source]

Retrieves the configuration for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_config_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ControllerConfigurationEntity) – The controller configuration. (required)

Returns:

ControllerConfigurationEntity If the method is called asynchronously, returns the request thread.

update_flow_registry_client(id, body, **kwargs)[source]

Updates a flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow_registry_client(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

  • body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

update_flow_registry_client_with_http_info(id, body, **kwargs)[source]

Updates a flow registry client

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_flow_registry_client_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The flow registry client id. (required)

  • body (FlowRegistryClientEntity) – The flow registry client configuration details. (required)

Returns:

FlowRegistryClientEntity If the method is called asynchronously, returns the request thread.

update_node(id, body, **kwargs)[source]

Updates a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_node(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (NodeEntity) – The node configuration. The only configuration that will be honored at this endpoint is the status. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

update_node_with_http_info(id, body, **kwargs)[source]

Updates a node in the cluster

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_node_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (NodeEntity) – The node configuration. The only configuration that will be honored at this endpoint is the status. (required)

Returns:

NodeEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.controller_services_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.controller_services_api.ControllerServicesApi(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

analyze_configuration(id, body, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

analyze_configuration_with_http_info(id, body, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

clear_state(id, **kwargs)[source]

Clears the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

clear_state_with_http_info(id, **kwargs)[source]

Clears the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

delete_verification_request(id, request_id, **kwargs)[source]

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Controller Service (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

delete_verification_request_with_http_info(id, request_id, **kwargs)[source]

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Controller Service (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_controller_service(id, **kwargs)[source]

Gets a controller service If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • ui_only (bool) –

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

get_controller_service_references(id, **kwargs)[source]

Gets a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_references(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

get_controller_service_references_with_http_info(id, **kwargs)[source]

Gets a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_references_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

get_controller_service_with_http_info(id, **kwargs)[source]

Gets a controller service If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • ui_only (bool) –

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)[source]

Gets a controller service property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • property_name (str) – The property name to return the descriptor for. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)[source]

Gets a controller service property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • property_name (str) – The property name to return the descriptor for. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)[source]

Gets the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)[source]

Gets the state for a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_verification_request(id, request_id, **kwargs)[source]

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Controller Service (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_verification_request_with_http_info(id, request_id, **kwargs)[source]

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Controller Service (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

remove_controller_service(id, **kwargs)[source]

Deletes a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_controller_service(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

remove_controller_service_with_http_info(id, **kwargs)[source]

Deletes a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_controller_service_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request(id, body, **kwargs)[source]

Performs verification of the Controller Service’s configuration This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (VerifyConfigRequestEntity) – The controller service configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request_with_http_info(id, body, **kwargs)[source]

Performs verification of the Controller Service’s configuration This will initiate the process of verifying a given Controller Service configuration. This may be a long-running task. As a result, this endpoint will immediately return a ControllerServiceConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /controller-services/{serviceId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /controller-services/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (VerifyConfigRequestEntity) – The controller service configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

update_controller_service(id, body, **kwargs)[source]

Updates a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

update_controller_service_references(id, body, **kwargs)[source]

Updates a controller services references

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service_references(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (UpdateControllerServiceReferenceRequestEntity) – The controller service request update request. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

update_controller_service_references_with_http_info(id, body, **kwargs)[source]

Updates a controller services references

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service_references_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (UpdateControllerServiceReferenceRequestEntity) – The controller service request update request. (required)

Returns:

ControllerServiceReferencingComponentsEntity If the method is called asynchronously, returns the request thread.

update_controller_service_with_http_info(id, body, **kwargs)[source]

Updates a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_controller_service_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)[source]

Updates run status of a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (ControllerServiceRunStatusEntity) – The controller service run status. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)[source]

Updates run status of a controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The controller service id. (required)

  • body (ControllerServiceRunStatusEntity) – The controller service run status. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.counters_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.counters_api.CountersApi(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

get_counters(**kwargs)[source]

Gets the current counters for this NiFi Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_counters(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

CountersEntity If the method is called asynchronously, returns the request thread.

get_counters_with_http_info(**kwargs)[source]

Gets the current counters for this NiFi Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_counters_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

CountersEntity If the method is called asynchronously, returns the request thread.

update_counter(id, **kwargs)[source]

Updates the specified counter. This will reset the counter value to 0 Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_counter(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the counter. (required)

Returns:

CounterEntity If the method is called asynchronously, returns the request thread.

update_counter_with_http_info(id, **kwargs)[source]

Updates the specified counter. This will reset the counter value to 0 Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_counter_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the counter. (required)

Returns:

CounterEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.data_transfer_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

OpenAPI spec version: 1.23.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

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_input_port_transaction(response_code, port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_input_port_transaction_with_http_info(response_code, port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_output_port_transaction(response_code, checksum, port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.commit_output_port_transaction_with_http_info(response_code, checksum, port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_port_transaction(port_type, port_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • port_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_port_transaction_with_http_info(port_type, port_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • port_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_input_port_transaction_ttl(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • port_id (str) – (required)

  • transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_input_port_transaction_ttl_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • port_id (str) – (required)

  • transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_output_port_transaction_ttl(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • port_id (str) – (required)

  • transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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

Extend transaction TTL

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.extend_output_port_transaction_ttl_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • port_id (str) – (required)

  • transaction_id (str) – (required)

Returns:

TransactionResultEntity If the method is called asynchronously, returns the request thread.

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

Transfer flow files to the input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.receive_flow_files(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • transaction_id (str) – (required)

Returns:

str If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.receive_flow_files_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • transaction_id (str) – (required)

Returns:

str If the method is called asynchronously, returns the request thread.

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

Transfer flow files from the output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.transfer_flow_files(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • transaction_id (str) – (required)

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.transfer_flow_files_with_http_info(port_id, transaction_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • transaction_id (str) – (required)

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.flow_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.flow_api.FlowApi(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

activate_controller_services(id, body, **kwargs)[source]

Enable or disable Controller Services in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.activate_controller_services(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ActivateControllerServicesEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ActivateControllerServicesEntity If the method is called asynchronously, returns the request thread.

activate_controller_services_with_http_info(id, body, **kwargs)[source]

Enable or disable Controller Services in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.activate_controller_services_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ActivateControllerServicesEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ActivateControllerServicesEntity If the method is called asynchronously, returns the request thread.

generate_client_id(**kwargs)[source]

Generates a client id.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.generate_client_id(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

str If the method is called asynchronously, returns the request thread.

generate_client_id_with_http_info(**kwargs)[source]

Generates a client id.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.generate_client_id_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

str If the method is called asynchronously, returns the request thread.

get_about_info(**kwargs)[source]

Retrieves details about this NiFi to put in the About dialog

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_about_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AboutEntity If the method is called asynchronously, returns the request thread.

get_about_info_with_http_info(**kwargs)[source]

Retrieves details about this NiFi to put in the About dialog

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_about_info_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

AboutEntity If the method is called asynchronously, returns the request thread.

get_action(id, **kwargs)[source]

Gets an action Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_action(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ActionEntity If the method is called asynchronously, returns the request thread.

get_action_with_http_info(id, **kwargs)[source]

Gets an action Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_action_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ActionEntity If the method is called asynchronously, returns the request thread.

get_banners(**kwargs)[source]

Retrieves the banners for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_banners(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

BannerEntity If the method is called asynchronously, returns the request thread.

get_banners_with_http_info(**kwargs)[source]

Retrieves the banners for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_banners_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

BannerEntity If the method is called asynchronously, returns the request thread.

get_buckets(id, **kwargs)[source]

Gets the buckets from the specified registry for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

FlowRegistryBucketsEntity If the method is called asynchronously, returns the request thread.

get_buckets_with_http_info(id, **kwargs)[source]

Gets the buckets from the specified registry for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_buckets_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

FlowRegistryBucketsEntity If the method is called asynchronously, returns the request thread.

get_bulletin_board(**kwargs)[source]

Gets current bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletin_board(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • after (str) – Includes bulletins with an id after this value.

  • source_name (str) – Includes bulletins originating from this sources whose name match this regular expression.

  • message (str) – Includes bulletins whose message that match this regular expression.

  • source_id (str) – Includes bulletins originating from this sources whose id match this regular expression.

  • group_id (str) – Includes bulletins originating from this sources whose group id match this regular expression.

  • limit (str) – The number of bulletins to limit the response to.

Returns:

BulletinBoardEntity If the method is called asynchronously, returns the request thread.

get_bulletin_board_with_http_info(**kwargs)[source]

Gets current bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletin_board_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • after (str) – Includes bulletins with an id after this value.

  • source_name (str) – Includes bulletins originating from this sources whose name match this regular expression.

  • message (str) – Includes bulletins whose message that match this regular expression.

  • source_id (str) – Includes bulletins originating from this sources whose id match this regular expression.

  • group_id (str) – Includes bulletins originating from this sources whose group id match this regular expression.

  • limit (str) – The number of bulletins to limit the response to.

Returns:

BulletinBoardEntity If the method is called asynchronously, returns the request thread.

get_bulletins(**kwargs)[source]

Retrieves Controller level bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletins(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerBulletinsEntity If the method is called asynchronously, returns the request thread.

get_bulletins_with_http_info(**kwargs)[source]

Retrieves Controller level bulletins

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_bulletins_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerBulletinsEntity If the method is called asynchronously, returns the request thread.

get_cluster_summary(**kwargs)[source]

The cluster summary for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster_summary(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ClusteSummaryEntity If the method is called asynchronously, returns the request thread.

get_cluster_summary_with_http_info(**kwargs)[source]

The cluster summary for this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_cluster_summary_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ClusteSummaryEntity If the method is called asynchronously, returns the request thread.

get_component_history(component_id, **kwargs)[source]

Gets configuration history for a component Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_component_history(component_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • component_id (str) – The component id. (required)

Returns:

ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_component_history_with_http_info(component_id, **kwargs)[source]

Gets configuration history for a component Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_component_history_with_http_info(component_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • component_id (str) – The component id. (required)

Returns:

ComponentHistoryEntity If the method is called asynchronously, returns the request thread.

get_connection_statistics(id, **kwargs)[source]

Gets statistics for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_statistics(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the statistics.

Returns:

ConnectionStatisticsEntity If the method is called asynchronously, returns the request thread.

get_connection_statistics_with_http_info(id, **kwargs)[source]

Gets statistics for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_statistics_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the statistics.

Returns:

ConnectionStatisticsEntity If the method is called asynchronously, returns the request thread.

get_connection_status(id, **kwargs)[source]

Gets status for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

ConnectionStatusEntity If the method is called asynchronously, returns the request thread.

get_connection_status_history(id, **kwargs)[source]

Gets the status history for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status_history(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_connection_status_history_with_http_info(id, **kwargs)[source]

Gets the status history for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status_history_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_connection_status_with_http_info(id, **kwargs)[source]

Gets status for a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connection_status_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

ConnectionStatusEntity If the method is called asynchronously, returns the request thread.

get_controller_service_types(**kwargs)[source]

Retrieves the types of controller services that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_types(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • service_type (str) – If specified, will only return controller services that are compatible with this type of service.

  • service_bundle_group (str) – If serviceType specified, is the bundle group of the serviceType.

  • service_bundle_artifact (str) – If serviceType specified, is the bundle artifact of the serviceType.

  • service_bundle_version (str) – If serviceType specified, is the bundle version of the serviceType.

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type_filter (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ControllerServiceTypesEntity If the method is called asynchronously, returns the request thread.

get_controller_service_types_with_http_info(**kwargs)[source]

Retrieves the types of controller services that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_service_types_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • service_type (str) – If specified, will only return controller services that are compatible with this type of service.

  • service_bundle_group (str) – If serviceType specified, is the bundle group of the serviceType.

  • service_bundle_artifact (str) – If serviceType specified, is the bundle artifact of the serviceType.

  • service_bundle_version (str) – If serviceType specified, is the bundle version of the serviceType.

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type_filter (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ControllerServiceTypesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_controller(**kwargs)[source]

Gets controller services for reporting tasks If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_controller(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • ui_only (bool) –

  • include_referencing_components (bool) – Whether or not to include services’ referencing components in the response

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_controller_with_http_info(**kwargs)[source]

Gets controller services for reporting tasks If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_controller_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • ui_only (bool) –

  • include_referencing_components (bool) – Whether or not to include services’ referencing components in the response

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_group(id, **kwargs)[source]

Gets all controller services If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_ancestor_groups (bool) – Whether or not to include parent/ancestor process groups

  • include_descendant_groups (bool) – Whether or not to include descendant process groups

  • include_referencing_components (bool) – Whether or not to include services’ referencing components in the response

  • ui_only (bool) –

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_services_from_group_with_http_info(id, **kwargs)[source]

Gets all controller services If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_services_from_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_ancestor_groups (bool) – Whether or not to include parent/ancestor process groups

  • include_descendant_groups (bool) – Whether or not to include descendant process groups

  • include_referencing_components (bool) – Whether or not to include services’ referencing components in the response

  • ui_only (bool) –

Returns:

ControllerServicesEntity If the method is called asynchronously, returns the request thread.

get_controller_status(**kwargs)[source]

Gets the current status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_status(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerStatusEntity If the method is called asynchronously, returns the request thread.

get_controller_status_with_http_info(**kwargs)[source]

Gets the current status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_controller_status_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerStatusEntity If the method is called asynchronously, returns the request thread.

get_current_user(**kwargs)[source]

Retrieves the user identity of the user making the request

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_current_user(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

CurrentUserEntity If the method is called asynchronously, returns the request thread.

get_current_user_with_http_info(**kwargs)[source]

Retrieves the user identity of the user making the request

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_current_user_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

CurrentUserEntity If the method is called asynchronously, returns the request thread.

get_details(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the details of a flow from the specified registry and bucket for the specified flow for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_details(registry_id, bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • registry_id (str) – The registry client id. (required)

  • bucket_id (str) – The bucket id. (required)

  • flow_id (str) – The flow id. (required)

Returns:

VersionedFlowEntity If the method is called asynchronously, returns the request thread.

get_details_with_http_info(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the details of a flow from the specified registry and bucket for the specified flow for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_details_with_http_info(registry_id, bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • registry_id (str) – The registry client id. (required)

  • bucket_id (str) – The bucket id. (required)

  • flow_id (str) – The flow id. (required)

Returns:

VersionedFlowEntity If the method is called asynchronously, returns the request thread.

get_flow(id, **kwargs)[source]

Gets a process group If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • ui_only (bool) –

Returns:

ProcessGroupFlowEntity If the method is called asynchronously, returns the request thread.

get_flow_config(**kwargs)[source]

Retrieves the configuration for this NiFi flow

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_config(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowConfigurationEntity If the method is called asynchronously, returns the request thread.

get_flow_config_with_http_info(**kwargs)[source]

Retrieves the configuration for this NiFi flow

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_config_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowConfigurationEntity If the method is called asynchronously, returns the request thread.

get_flow_metrics(producer, **kwargs)[source]

Gets all metrics for the flow from a particular node

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_metrics(producer, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • producer (str) – The producer for flow file metrics. Each producer may have its own output format. (required)

  • included_registries (list[str]) – Set of included metrics registries

  • sample_name (str) – Regular Expression Pattern to be applied against the sample name field

  • sample_label_value (str) – Regular Expression Pattern to be applied against the sample label value field

  • root_field_name (str) – Name of the first field of JSON object. Applicable for JSON producer only.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_flow_metrics_with_http_info(producer, **kwargs)[source]

Gets all metrics for the flow from a particular node

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_metrics_with_http_info(producer, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • producer (str) – The producer for flow file metrics. Each producer may have its own output format. (required)

  • included_registries (list[str]) – Set of included metrics registries

  • sample_name (str) – Regular Expression Pattern to be applied against the sample name field

  • sample_label_value (str) – Regular Expression Pattern to be applied against the sample label value field

  • root_field_name (str) – Name of the first field of JSON object. Applicable for JSON producer only.

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_flow_with_http_info(id, **kwargs)[source]

Gets a process group If the uiOnly query parameter is provided with a value of true, the returned entity may only contain fields that are necessary for rendering the NiFi User Interface. As such, the selected fields may change at any time, even during incremental releases, without warning. As a result, this parameter should not be provided by any client other than the UI. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • ui_only (bool) –

Returns:

ProcessGroupFlowEntity If the method is called asynchronously, returns the request thread.

get_flows(registry_id, bucket_id, **kwargs)[source]

Gets the flows from the specified registry and bucket for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows(registry_id, bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • registry_id (str) – The registry client id. (required)

  • bucket_id (str) – The bucket id. (required)

Returns:

VersionedFlowsEntity If the method is called asynchronously, returns the request thread.

get_flows_with_http_info(registry_id, bucket_id, **kwargs)[source]

Gets the flows from the specified registry and bucket for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flows_with_http_info(registry_id, bucket_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • registry_id (str) – The registry client id. (required)

  • bucket_id (str) – The bucket id. (required)

Returns:

VersionedFlowsEntity If the method is called asynchronously, returns the request thread.

get_input_port_status(id, **kwargs)[source]

Gets status for an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port_status(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_input_port_status_with_http_info(id, **kwargs)[source]

Gets status for an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port_status_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_output_port_status(id, **kwargs)[source]

Gets status for an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port_status(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_output_port_status_with_http_info(id, **kwargs)[source]

Gets status for an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port_status_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

PortStatusEntity If the method is called asynchronously, returns the request thread.

get_parameter_contexts(**kwargs)[source]

Gets all Parameter Contexts

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_contexts(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ParameterContextsEntity If the method is called asynchronously, returns the request thread.

get_parameter_contexts_with_http_info(**kwargs)[source]

Gets all Parameter Contexts

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_contexts_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ParameterContextsEntity If the method is called asynchronously, returns the request thread.

get_parameter_provider_types(**kwargs)[source]

Retrieves the types of parameter providers that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_provider_types(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ParameterProviderTypesEntity If the method is called asynchronously, returns the request thread.

get_parameter_provider_types_with_http_info(**kwargs)[source]

Retrieves the types of parameter providers that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_provider_types_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ParameterProviderTypesEntity If the method is called asynchronously, returns the request thread.

get_parameter_providers(**kwargs)[source]

Gets all parameter providers

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_providers(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ParameterProvidersEntity If the method is called asynchronously, returns the request thread.

get_parameter_providers_with_http_info(**kwargs)[source]

Gets all parameter providers

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_providers_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ParameterProvidersEntity If the method is called asynchronously, returns the request thread.

get_prioritizers(**kwargs)[source]

Retrieves the types of prioritizers that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_prioritizers(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

PrioritizerTypesEntity If the method is called asynchronously, returns the request thread.

get_prioritizers_with_http_info(**kwargs)[source]

Retrieves the types of prioritizers that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_prioritizers_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

PrioritizerTypesEntity If the method is called asynchronously, returns the request thread.

get_process_group_status(id, **kwargs)[source]

Gets the status for a process group The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • recursive (bool) – Whether all descendant groups and the status of their content will be included. Optional, defaults to false

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_process_group_status_history(id, **kwargs)[source]

Gets status history for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status_history(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_process_group_status_history_with_http_info(id, **kwargs)[source]

Gets status history for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status_history_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_process_group_status_with_http_info(id, **kwargs)[source]

Gets the status for a process group The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_status_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • recursive (bool) – Whether all descendant groups and the status of their content will be included. Optional, defaults to false

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_processor_status(id, **kwargs)[source]

Gets status for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessorStatusEntity If the method is called asynchronously, returns the request thread.

get_processor_status_history(id, **kwargs)[source]

Gets status history for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status_history(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_processor_status_history_with_http_info(id, **kwargs)[source]

Gets status history for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status_history_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_processor_status_with_http_info(id, **kwargs)[source]

Gets status for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_status_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

ProcessorStatusEntity If the method is called asynchronously, returns the request thread.

get_processor_types(**kwargs)[source]

Retrieves the types of processors that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_types(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ProcessorTypesEntity If the method is called asynchronously, returns the request thread.

get_processor_types_with_http_info(**kwargs)[source]

Retrieves the types of processors that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_types_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ProcessorTypesEntity If the method is called asynchronously, returns the request thread.

get_registry_clients(**kwargs)[source]

Gets the listing of available flow registry clients

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_clients(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowRegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_registry_clients_with_http_info(**kwargs)[source]

Gets the listing of available flow registry clients

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_registry_clients_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

FlowRegistryClientsEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status(id, **kwargs)[source]

Gets status for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

RemoteProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status_history(id, **kwargs)[source]

Gets the status history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status_history(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status_history_with_http_info(id, **kwargs)[source]

Gets the status history

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status_history_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

Returns:

StatusHistoryEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_status_with_http_info(id, **kwargs)[source]

Gets status for a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_status_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

RemoteProcessGroupStatusEntity If the method is called asynchronously, returns the request thread.

get_reporting_task_types(**kwargs)[source]

Retrieves the types of reporting tasks that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task_types(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ReportingTaskTypesEntity If the method is called asynchronously, returns the request thread.

get_reporting_task_types_with_http_info(**kwargs)[source]

Retrieves the types of reporting tasks that this NiFi supports Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task_types_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.

  • bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.

  • type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

ReportingTaskTypesEntity If the method is called asynchronously, returns the request thread.

get_reporting_tasks(**kwargs)[source]

Gets all reporting tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_tasks(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ReportingTasksEntity If the method is called asynchronously, returns the request thread.

get_reporting_tasks_with_http_info(**kwargs)[source]

Gets all reporting tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_tasks_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ReportingTasksEntity If the method is called asynchronously, returns the request thread.

get_runtime_manifest(**kwargs)[source]

Retrieves the runtime manifest for this NiFi instance. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_runtime_manifest(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

RuntimeManifestEntity If the method is called asynchronously, returns the request thread.

get_runtime_manifest_with_http_info(**kwargs)[source]

Retrieves the runtime manifest for this NiFi instance. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_runtime_manifest_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

RuntimeManifestEntity If the method is called asynchronously, returns the request thread.

get_templates(**kwargs)[source]

Gets all templates

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_templates(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

TemplatesEntity If the method is called asynchronously, returns the request thread.

get_templates_with_http_info(**kwargs)[source]

Gets all templates

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_templates_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

TemplatesEntity If the method is called asynchronously, returns the request thread.

get_versions(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the flow versions from the specified registry and bucket for the specified flow for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_versions(registry_id, bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • registry_id (str) – The registry client id. (required)

  • bucket_id (str) – The bucket id. (required)

  • flow_id (str) – The flow id. (required)

Returns:

VersionedFlowSnapshotMetadataSetEntity If the method is called asynchronously, returns the request thread.

get_versions_with_http_info(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the flow versions from the specified registry and bucket for the specified flow for the current user

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_versions_with_http_info(registry_id, bucket_id, flow_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • registry_id (str) – The registry client id. (required)

  • bucket_id (str) – The bucket id. (required)

  • flow_id (str) – The flow id. (required)

Returns:

VersionedFlowSnapshotMetadataSetEntity If the method is called asynchronously, returns the request thread.

query_history(offset, count, **kwargs)[source]

Gets configuration history Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.query_history(offset, count, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • offset (str) – The offset into the result set. (required)

  • count (str) – The number of actions to return. (required)

  • sort_column (str) – The field to sort on.

  • sort_order (str) – The direction to sort.

  • start_date (str) – Include actions after this date.

  • end_date (str) – Include actions before this date.

  • user_identity (str) – Include actions performed by this user.

  • source_id (str) – Include actions on this component.

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

query_history_with_http_info(offset, count, **kwargs)[source]

Gets configuration history Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.query_history_with_http_info(offset, count, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • offset (str) – The offset into the result set. (required)

  • count (str) – The number of actions to return. (required)

  • sort_column (str) – The field to sort on.

  • sort_order (str) – The direction to sort.

  • start_date (str) – Include actions after this date.

  • end_date (str) – Include actions before this date.

  • user_identity (str) – Include actions performed by this user.

  • source_id (str) – Include actions on this component.

Returns:

HistoryEntity If the method is called asynchronously, returns the request thread.

schedule_components(id, body, **kwargs)[source]

Schedule or unschedule components in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.schedule_components(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ScheduleComponentsEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ScheduleComponentsEntity If the method is called asynchronously, returns the request thread.

schedule_components_with_http_info(id, body, **kwargs)[source]

Schedule or unschedule components in the specified Process Group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.schedule_components_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ScheduleComponentsEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)

Returns:

ScheduleComponentsEntity If the method is called asynchronously, returns the request thread.

search_cluster(q, **kwargs)[source]

Searches the cluster for a node with the specified address Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_cluster(q, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • q (str) – Node address to search for. (required)

Returns:

ClusterSearchResultsEntity If the method is called asynchronously, returns the request thread.

search_cluster_with_http_info(q, **kwargs)[source]

Searches the cluster for a node with the specified address Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_cluster_with_http_info(q, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • q (str) – Node address to search for. (required)

Returns:

ClusterSearchResultsEntity If the method is called asynchronously, returns the request thread.

search_flow(**kwargs)[source]

Performs a search against this NiFi using the specified search term Only search results from authorized components will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_flow(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • q (str) –

  • a (str) –

Returns:

SearchResultsEntity If the method is called asynchronously, returns the request thread.

search_flow_with_http_info(**kwargs)[source]

Performs a search against this NiFi using the specified search term Only search results from authorized components will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.search_flow_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • q (str) –

  • a (str) –

Returns:

SearchResultsEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.flowfile_queues_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.flowfile_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

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_drop_request(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_drop_request_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_flow_file_listing(id, **kwargs)[source]

Lists the contents of the queue in this connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_file_listing(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_flow_file_listing_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_listing_request(id, listing_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_listing_request_with_http_info(id, listing_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.download_flow_file_content(id, flowfile_uuid, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

  • client_id (str) – 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 If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.download_flow_file_content_with_http_info(id, flowfile_uuid, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

  • client_id (str) – 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 If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_request(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

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

Gets a FlowFile from a Connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_file(id, flowfile_uuid, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • 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 If the method is called asynchronously, returns the request thread.

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

Gets a FlowFile from a Connection.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_flow_file_with_http_info(id, flowfile_uuid, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • 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 If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_listing_request(id, listing_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_listing_request_with_http_info(id, listing_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

ListingRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

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 by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.funnel_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.funnel_api.FunnelApi(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

get_funnel(id, **kwargs)[source]

Gets a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnel(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

get_funnel_with_http_info(id, **kwargs)[source]

Gets a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnel_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

remove_funnel(id, **kwargs)[source]

Deletes a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_funnel(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

remove_funnel_with_http_info(id, **kwargs)[source]

Deletes a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_funnel_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

update_funnel(id, body, **kwargs)[source]

Updates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_funnel(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

update_funnel_with_http_info(id, body, **kwargs)[source]

Updates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_funnel_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.input_ports_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.input_ports_api.InputPortsApi(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

get_input_port(id, **kwargs)[source]

Gets an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

get_input_port_with_http_info(id, **kwargs)[source]

Gets an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_port_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_input_port(id, **kwargs)[source]

Deletes an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_input_port(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_input_port_with_http_info(id, **kwargs)[source]

Deletes an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_input_port_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_input_port(id, body, **kwargs)[source]

Updates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_input_port(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_input_port_with_http_info(id, body, **kwargs)[source]

Updates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_input_port_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)[source]

Updates run status of an input-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)[source]

Updates run status of an input-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.labels_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.labels_api.LabelsApi(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

get_label(id, **kwargs)[source]

Gets a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_label(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

get_label_with_http_info(id, **kwargs)[source]

Gets a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_label_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

remove_label(id, **kwargs)[source]

Deletes a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_label(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

remove_label_with_http_info(id, **kwargs)[source]

Deletes a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_label_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

update_label(id, body, **kwargs)[source]

Updates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_label(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

update_label_with_http_info(id, body, **kwargs)[source]

Updates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_label_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.output_ports_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.output_ports_api.OutputPortsApi(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

get_output_port(id, **kwargs)[source]

Gets an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

get_output_port_with_http_info(id, **kwargs)[source]

Gets an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_port_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_output_port(id, **kwargs)[source]

Deletes an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_output_port(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

remove_output_port_with_http_info(id, **kwargs)[source]

Deletes an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_output_port_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_output_port(id, body, **kwargs)[source]

Updates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_output_port(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortEntity) – The output port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_output_port_with_http_info(id, body, **kwargs)[source]

Updates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_output_port_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortEntity) – The output port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)[source]

Updates run status of an output-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)[source]

Updates run status of an output-port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (PortRunStatusEntity) – The port run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.parameter_contexts_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.parameter_contexts_api.ParameterContextsApi(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

create_parameter_context(body, **kwargs)[source]

Create a Parameter Context

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_parameter_context(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ParameterContextEntity) – The Parameter Context. (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

create_parameter_context_with_http_info(body, **kwargs)[source]

Create a Parameter Context

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_parameter_context_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ParameterContextEntity) – The Parameter Context. (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

delete_parameter_context(id, **kwargs)[source]

Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_parameter_context(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The Parameter Context ID. (required)

  • version (str) – The version is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

delete_parameter_context_with_http_info(id, **kwargs)[source]

Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_parameter_context_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The Parameter Context ID. (required)

  • version (str) – The version is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

delete_update_request(context_id, request_id, **kwargs)[source]

Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_update_request(context_id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the ParameterContext (required)

  • request_id (str) – The ID of the Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_update_request_with_http_info(context_id, request_id, **kwargs)[source]

Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_update_request_with_http_info(context_id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the ParameterContext (required)

  • request_id (str) – The ID of the Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_validation_request(context_id, id, **kwargs)[source]

Deletes the Validation Request with the given ID Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE’ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request(context_id, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the Parameter Context (required)

  • id (str) – The ID of the Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

delete_validation_request_with_http_info(context_id, id, **kwargs)[source]

Deletes the Validation Request with the given ID Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE’ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_validation_request_with_http_info(context_id, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the Parameter Context (required)

  • id (str) – The ID of the Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

get_parameter_context(id, **kwargs)[source]

Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Parameter Context (required)

  • include_inherited_parameters (bool) – Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the ‘effective’ parameter context.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

get_parameter_context_update(context_id, request_id, **kwargs)[source]

Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context_update(context_id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the Parameter Context (required)

  • request_id (str) – The ID of the Update Request (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_parameter_context_update_with_http_info(context_id, request_id, **kwargs)[source]

Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context_update_with_http_info(context_id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the Parameter Context (required)

  • request_id (str) – The ID of the Update Request (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_parameter_context_with_http_info(id, **kwargs)[source]

Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_parameter_context_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Parameter Context (required)

  • include_inherited_parameters (bool) – Whether or not to include inherited parameters from other parameter contexts, and therefore also overridden values. If true, the result will be the ‘effective’ parameter context.

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

get_validation_request(context_id, id, **kwargs)[source]

Returns the Validation Request with the given ID Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_validation_request(context_id, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the Parameter Context (required)

  • id (str) – The ID of the Validation Request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

get_validation_request_with_http_info(context_id, id, **kwargs)[source]

Returns the Validation Request with the given ID Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_validation_request_with_http_info(context_id, id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – The ID of the Parameter Context (required)

  • id (str) – The ID of the Validation Request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

submit_parameter_context_update(context_id, body, **kwargs)[source]

Initiate the Update Request of a Parameter Context This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_parameter_context_update(context_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – (required)

  • body (ParameterContextEntity) – The updated version of the parameter context. (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

submit_parameter_context_update_with_http_info(context_id, body, **kwargs)[source]

Initiate the Update Request of a Parameter Context This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this action may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_parameter_context_update_with_http_info(context_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – (required)

  • body (ParameterContextEntity) – The updated version of the parameter context. (required)

Returns:

ParameterContextUpdateRequestEntity If the method is called asynchronously, returns the request thread.

submit_validation_request(context_id, body, **kwargs)[source]

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_validation_request(context_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – (required)

  • body (ParameterContextValidationRequestEntity) – The validation request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

submit_validation_request_with_http_info(context_id, body, **kwargs)[source]

Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_validation_request_with_http_info(context_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • context_id (str) – (required)

  • body (ParameterContextValidationRequestEntity) – The validation request (required)

Returns:

ParameterContextValidationRequestEntity If the method is called asynchronously, returns the request thread.

update_parameter_context(id, body, **kwargs)[source]

Modifies a Parameter Context This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_parameter_context(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – (required)

  • body (ParameterContextEntity) – The updated Parameter Context (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

update_parameter_context_with_http_info(id, body, **kwargs)[source]

Modifies a Parameter Context This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_parameter_context_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – (required)

  • body (ParameterContextEntity) – The updated Parameter Context (required)

Returns:

ParameterContextEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.policies_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.policies_api.PoliciesApi(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

create_access_policy(body, **kwargs)[source]

Creates an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

create_access_policy_with_http_info(body, **kwargs)[source]

Creates an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_access_policy_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy(id, **kwargs)[source]

Gets an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The access policy id. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy_for_resource(action, resource, **kwargs)[source]

Gets an access policy for the specified action and resource Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource(action, resource, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • action (str) – The request action. (required)

  • resource (str) – The resource of the policy. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy_for_resource_with_http_info(action, resource, **kwargs)[source]

Gets an access policy for the specified action and resource Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_for_resource_with_http_info(action, resource, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • action (str) – The request action. (required)

  • resource (str) – The resource of the policy. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

get_access_policy_with_http_info(id, **kwargs)[source]

Gets an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_access_policy_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The access policy id. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

remove_access_policy(id, **kwargs)[source]

Deletes an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The access policy id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

remove_access_policy_with_http_info(id, **kwargs)[source]

Deletes an access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_access_policy_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The access policy id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

update_access_policy(id, body, **kwargs)[source]

Updates a access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The access policy id. (required)

  • body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

update_access_policy_with_http_info(id, body, **kwargs)[source]

Updates a access policy

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_access_policy_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The access policy id. (required)

  • body (AccessPolicyEntity) – The access policy configuration details. (required)

Returns:

AccessPolicyEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.process_groups_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.process_groups_api.ProcessGroupsApi(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

copy_snippet(id, body, **kwargs)[source]

Copies a snippet and discards it.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.copy_snippet(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (CopySnippetRequestEntity) – The copy snippet request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

copy_snippet_with_http_info(id, body, **kwargs)[source]

Copies a snippet and discards it.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.copy_snippet_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (CopySnippetRequestEntity) – The copy snippet request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

create_connection(id, body, **kwargs)[source]

Creates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_connection(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

create_connection_with_http_info(id, body, **kwargs)[source]

Creates a connection

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_connection_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ConnectionEntity) – The connection configuration details. (required)

Returns:

ConnectionEntity If the method is called asynchronously, returns the request thread.

create_controller_service(id, body, **kwargs)[source]

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_controller_service_with_http_info(id, body, **kwargs)[source]

Creates a new controller service

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_controller_service_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ControllerServiceEntity) – The controller service configuration details. (required)

Returns:

ControllerServiceEntity If the method is called asynchronously, returns the request thread.

create_empty_all_connections_request(id, **kwargs)[source]

Creates a request to drop all flowfiles of all connection queues in this process group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_empty_all_connections_request(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_empty_all_connections_request_with_http_info(id, **kwargs)[source]

Creates a request to drop all flowfiles of all connection queues in this process group.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_empty_all_connections_request_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

create_funnel(id, body, **kwargs)[source]

Creates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_funnel(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

create_funnel_with_http_info(id, body, **kwargs)[source]

Creates a funnel

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_funnel_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (FunnelEntity) – The funnel configuration details. (required)

Returns:

FunnelEntity If the method is called asynchronously, returns the request thread.

create_input_port(id, body, **kwargs)[source]

Creates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_input_port(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_input_port_with_http_info(id, body, **kwargs)[source]

Creates an input port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_input_port_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (PortEntity) – The input port configuration details. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_label(id, body, **kwargs)[source]

Creates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_label(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

create_label_with_http_info(id, body, **kwargs)[source]

Creates a label

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_label_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (LabelEntity) – The label configuration details. (required)

Returns:

LabelEntity If the method is called asynchronously, returns the request thread.

create_output_port(id, body, **kwargs)[source]

Creates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_output_port(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (PortEntity) – The output port configuration. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_output_port_with_http_info(id, body, **kwargs)[source]

Creates an output port

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_output_port_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (PortEntity) – The output port configuration. (required)

Returns:

PortEntity If the method is called asynchronously, returns the request thread.

create_process_group(id, body, **kwargs)[source]

Creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_process_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupEntity) – The process group configuration details. (required)

  • parameter_context_handling_strategy (str) – Handling Strategy controls whether to keep or replace Parameter Contexts

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_process_group_with_http_info(id, body, **kwargs)[source]

Creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_process_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupEntity) – The process group configuration details. (required)

  • parameter_context_handling_strategy (str) – Handling Strategy controls whether to keep or replace Parameter Contexts

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_processor(id, body, **kwargs)[source]

Creates a new processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_processor(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

create_processor_with_http_info(id, body, **kwargs)[source]

Creates a new processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_processor_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

create_remote_process_group(id, body, **kwargs)[source]

Creates a new process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_remote_process_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (RemoteProcessGroupEntity) – The remote process group configuration details. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_remote_process_group_with_http_info(id, body, **kwargs)[source]

Creates a new process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_remote_process_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (RemoteProcessGroupEntity) – The remote process group configuration details. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

create_template(id, body, **kwargs)[source]

Creates a template and discards the specified snippet.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_template(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (CreateTemplateRequestEntity) – The create template request. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

create_template_with_http_info(id, body, **kwargs)[source]

Creates a template and discards the specified snippet.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_template_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (CreateTemplateRequestEntity) – The create template request. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

delete_replace_process_group_request(id, **kwargs)[source]

Deletes the Replace Request with the given ID Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_replace_process_group_request(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

delete_replace_process_group_request_with_http_info(id, **kwargs)[source]

Deletes the Replace Request with the given ID Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE’ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_replace_process_group_request_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

delete_variable_registry_update_request(group_id, update_id, **kwargs)[source]

Deletes an update request for a process group’s variable registry. If the request is not yet complete, it will automatically be cancelled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_variable_registry_update_request(group_id, update_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • group_id (str) – The process group id. (required)

  • update_id (str) – The ID of the Variable Registry Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

delete_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs)[source]

Deletes an update request for a process group’s variable registry. If the request is not yet complete, it will automatically be cancelled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_variable_registry_update_request_with_http_info(group_id, update_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • group_id (str) – The process group id. (required)

  • update_id (str) – The ID of the Variable Registry Update Request (required)

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

export_process_group(id, **kwargs)[source]

Gets a process group for download

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_process_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_referenced_services (bool) – If referenced services from outside the target group should be included

Returns:

str If the method is called asynchronously, returns the request thread.

export_process_group_with_http_info(id, **kwargs)[source]

Gets a process group for download

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.export_process_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_referenced_services (bool) – If referenced services from outside the target group should be included

Returns:

str If the method is called asynchronously, returns the request thread.

get_connections(id, **kwargs)[source]

Gets all connections

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connections(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ConnectionsEntity If the method is called asynchronously, returns the request thread.

get_connections_with_http_info(id, **kwargs)[source]

Gets all connections

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_connections_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ConnectionsEntity If the method is called asynchronously, returns the request thread.

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

Gets the current status of a drop all flowfiles request.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_all_flowfiles_request(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

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

Gets the current status of a drop all flowfiles request.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_drop_all_flowfiles_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

get_funnels(id, **kwargs)[source]

Gets all funnels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnels(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

FunnelsEntity If the method is called asynchronously, returns the request thread.

get_funnels_with_http_info(id, **kwargs)[source]

Gets all funnels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_funnels_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

FunnelsEntity If the method is called asynchronously, returns the request thread.

get_input_ports(id, **kwargs)[source]

Gets all input ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_ports(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

InputPortsEntity If the method is called asynchronously, returns the request thread.

get_input_ports_with_http_info(id, **kwargs)[source]

Gets all input ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_ports_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

InputPortsEntity If the method is called asynchronously, returns the request thread.

get_labels(id, **kwargs)[source]

Gets all labels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_labels(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

LabelsEntity If the method is called asynchronously, returns the request thread.

get_labels_with_http_info(id, **kwargs)[source]

Gets all labels

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_labels_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

LabelsEntity If the method is called asynchronously, returns the request thread.

get_local_modifications(id, **kwargs)[source]

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_local_modifications(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

FlowComparisonEntity If the method is called asynchronously, returns the request thread.

get_local_modifications_with_http_info(id, **kwargs)[source]

Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_local_modifications_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

FlowComparisonEntity If the method is called asynchronously, returns the request thread.

get_output_ports(id, **kwargs)[source]

Gets all output ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_ports(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

OutputPortsEntity If the method is called asynchronously, returns the request thread.

get_output_ports_with_http_info(id, **kwargs)[source]

Gets all output ports

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_ports_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

OutputPortsEntity If the method is called asynchronously, returns the request thread.

get_process_group(id, **kwargs)[source]

Gets a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_process_group_with_http_info(id, **kwargs)[source]

Gets a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_process_groups(id, **kwargs)[source]

Gets all process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_groups(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_process_groups_with_http_info(id, **kwargs)[source]

Gets all process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_process_groups_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_processors(id, **kwargs)[source]

Gets all processors

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processors(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_descendant_groups (bool) – Whether or not to include processors from descendant process groups

Returns:

ProcessorsEntity If the method is called asynchronously, returns the request thread.

get_processors_with_http_info(id, **kwargs)[source]

Gets all processors

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processors_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_descendant_groups (bool) – Whether or not to include processors from descendant process groups

Returns:

ProcessorsEntity If the method is called asynchronously, returns the request thread.

get_remote_process_groups(id, **kwargs)[source]

Gets all remote process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_groups(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

RemoteProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_remote_process_groups_with_http_info(id, **kwargs)[source]

Gets all remote process groups

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_groups_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

RemoteProcessGroupsEntity If the method is called asynchronously, returns the request thread.

get_replace_process_group_request(id, **kwargs)[source]

Returns the Replace Request with the given ID Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_replace_process_group_request(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Replace Request (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

get_replace_process_group_request_with_http_info(id, **kwargs)[source]

Returns the Replace Request with the given ID Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_replace_process_group_request_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Replace Request (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

get_variable_registry(id, **kwargs)[source]

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_ancestor_groups (bool) – Whether or not to include ancestor groups

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

get_variable_registry_update_request(group_id, update_id, **kwargs)[source]

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry_update_request(group_id, update_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • group_id (str) – The process group id. (required)

  • update_id (str) – The ID of the Variable Registry Update Request (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_variable_registry_update_request_with_http_info(group_id, update_id, **kwargs)[source]

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry_update_request_with_http_info(group_id, update_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • group_id (str) – The process group id. (required)

  • update_id (str) – The ID of the Variable Registry Update Request (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

get_variable_registry_with_http_info(id, **kwargs)[source]

Gets a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_variable_registry_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • include_ancestor_groups (bool) – Whether or not to include ancestor groups

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

import_process_group(id, **kwargs)[source]

Imports a specified process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_process_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

import_process_group_with_http_info(id, **kwargs)[source]

Imports a specified process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_process_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

import_template(id, **kwargs)[source]

Imports a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_template(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

import_template_with_http_info(id, **kwargs)[source]

Imports a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.import_template_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

initiate_replace_process_group(id, body, **kwargs)[source]

Initiate the Replace Request of a Process Group with the given ID This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_replace_process_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupImportEntity) – The process group replace request entity (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

initiate_replace_process_group_with_http_info(id, body, **kwargs)[source]

Initiate the Replace Request of a Process Group with the given ID This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.initiate_replace_process_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupImportEntity) – The process group replace request entity (required)

Returns:

ProcessGroupReplaceRequestEntity If the method is called asynchronously, returns the request thread.

instantiate_template(id, body, **kwargs)[source]

Instantiates a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.instantiate_template(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (InstantiateTemplateRequestEntity) – The instantiate template request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

instantiate_template_with_http_info(id, body, **kwargs)[source]

Instantiates a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.instantiate_template_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (InstantiateTemplateRequestEntity) – The instantiate template request. (required)

Returns:

FlowEntity If the method is called asynchronously, returns the request thread.

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

Cancels and/or removes a request to drop all flowfiles.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

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

Cancels and/or removes a request to drop all flowfiles.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_drop_request_with_http_info(id, drop_request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

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

Returns:

DropRequestEntity If the method is called asynchronously, returns the request thread.

remove_process_group(id, **kwargs)[source]

Deletes a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_process_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

remove_process_group_with_http_info(id, **kwargs)[source]

Deletes a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_process_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

replace_process_group(id, body, **kwargs)[source]

Replace Process Group contents with the given ID with the specified Process Group contents This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.replace_process_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupImportEntity) – The process group replace request entity. (required)

Returns:

ProcessGroupImportEntity If the method is called asynchronously, returns the request thread.

replace_process_group_with_http_info(id, body, **kwargs)[source]

Replace Process Group contents with the given ID with the specified Process Group contents This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.replace_process_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupImportEntity) – The process group replace request entity. (required)

Returns:

ProcessGroupImportEntity If the method is called asynchronously, returns the request thread.

submit_update_variable_registry_request(id, body, **kwargs)[source]

Submits a request to update a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_update_variable_registry_request(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

submit_update_variable_registry_request_with_http_info(id, body, **kwargs)[source]

Submits a request to update a process group’s variable registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_update_variable_registry_request_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryUpdateRequestEntity If the method is called asynchronously, returns the request thread.

update_process_group(id, body, **kwargs)[source]

Updates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_process_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupEntity) – The process group configuration details. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_process_group_with_http_info(id, body, **kwargs)[source]

Updates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_process_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (ProcessGroupEntity) – The process group configuration details. (required)

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_variable_registry(id, body, **kwargs)[source]

Updates the contents of a Process Group’s variable Registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_variable_registry(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

update_variable_registry_with_http_info(id, body, **kwargs)[source]

Updates the contents of a Process Group’s variable Registry Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_variable_registry_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (VariableRegistryEntity) – The variable registry configuration details. (required)

Returns:

VariableRegistryEntity If the method is called asynchronously, returns the request thread.

upload_process_group(id, body, body2, body3, body4, **kwargs)[source]

Uploads a versioned flow definition and creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_process_group(id, body, body2, body3, body4, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (str) – The process group name. (required)

  • body2 (float) – The process group X position. (required)

  • body3 (float) – The process group Y position. (required)

  • body4 (str) – The client id. (required)

  • body5 (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

upload_process_group_with_http_info(id, body, body2, body3, body4, **kwargs)[source]

Uploads a versioned flow definition and creates a process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_process_group_with_http_info(id, body, body2, body3, body4, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (str) – The process group name. (required)

  • body2 (float) – The process group X position. (required)

  • body3 (float) – The process group Y position. (required)

  • body4 (str) – The client id. (required)

  • body5 (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessGroupEntity If the method is called asynchronously, returns the request thread.

upload_template(id, template, **kwargs)[source]

Uploads a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_template(id, template, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • template (file) – The binary content of the template file being uploaded. (required)

  • body (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

upload_template_with_http_info(id, template, **kwargs)[source]

Uploads a template

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.upload_template_with_http_info(id, template, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • template (file) – The binary content of the template file being uploaded. (required)

  • body (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

TemplateEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.processors_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.processors_api.ProcessorsApi(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

analyze_configuration(id, body, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ConfigurationAnalysisEntity) – The processor configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

analyze_configuration_with_http_info(id, body, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ConfigurationAnalysisEntity) – The processor configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

clear_state(id, **kwargs)[source]

Clears the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

clear_state_with_http_info(id, **kwargs)[source]

Clears the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

delete_processor(id, **kwargs)[source]

Deletes a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_processor(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

delete_processor_with_http_info(id, **kwargs)[source]

Deletes a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_processor_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

delete_verification_request(id, request_id, **kwargs)[source]

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

delete_verification_request_with_http_info(id, request_id, **kwargs)[source]

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_processor(id, **kwargs)[source]

Gets a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_processor_diagnostics(id, **kwargs)[source]

Gets diagnostics information about a processor Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_diagnostics(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_processor_diagnostics_with_http_info(id, **kwargs)[source]

Gets diagnostics information about a processor Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_diagnostics_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_processor_run_status_details(**kwargs)[source]

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_run_status_details(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (RunStatusDetailsRequestEntity) – The request for the processors that should be included in the results

Returns:

ProcessorsRunStatusDetailsEntity If the method is called asynchronously, returns the request thread.

get_processor_run_status_details_with_http_info(**kwargs)[source]

Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_run_status_details_with_http_info(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (RunStatusDetailsRequestEntity) – The request for the processors that should be included in the results

Returns:

ProcessorsRunStatusDetailsEntity If the method is called asynchronously, returns the request thread.

get_processor_with_http_info(id, **kwargs)[source]

Gets a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_processor_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)[source]

Gets the descriptor for a processor property

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • property_name (str) – The property name. (required)

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)[source]

Gets the descriptor for a processor property

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • property_name (str) – The property name. (required)

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)[source]

Gets the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)[source]

Gets the state for a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_verification_request(id, request_id, **kwargs)[source]

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_verification_request_with_http_info(id, request_id, **kwargs)[source]

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Processor (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_processor_verification_request(id, body, **kwargs)[source]

Performs verification of the Processor’s configuration This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_processor_verification_request(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (VerifyConfigRequestEntity) – The processor configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_processor_verification_request_with_http_info(id, body, **kwargs)[source]

Performs verification of the Processor’s configuration This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /processors/{processorId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_processor_verification_request_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (VerifyConfigRequestEntity) – The processor configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

terminate_processor(id, **kwargs)[source]

Terminates a processor, essentially “deleting” its threads and any active tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.terminate_processor(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

terminate_processor_with_http_info(id, **kwargs)[source]

Terminates a processor, essentially “deleting” its threads and any active tasks

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.terminate_processor_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_processor(id, body, **kwargs)[source]

Updates a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_processor(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_processor_with_http_info(id, body, **kwargs)[source]

Updates a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_processor_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ProcessorEntity) – The processor configuration details. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)[source]

Updates run status of a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ProcessorRunStatusEntity) – The processor run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)[source]

Updates run status of a processor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (ProcessorRunStatusEntity) – The processor run status. (required)

Returns:

ProcessorEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.provenance_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.provenance_api.ProvenanceApi(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

delete_lineage(id, **kwargs)[source]

Deletes a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_lineage(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the lineage query. (required)

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

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

delete_lineage_with_http_info(id, **kwargs)[source]

Deletes a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_lineage_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the lineage query. (required)

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

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

delete_provenance(id, **kwargs)[source]

Deletes a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_provenance(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the provenance query. (required)

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

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

delete_provenance_with_http_info(id, **kwargs)[source]

Deletes a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_provenance_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the provenance query. (required)

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

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

get_lineage(id, **kwargs)[source]

Gets a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_lineage(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the lineage query. (required)

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

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

get_lineage_with_http_info(id, **kwargs)[source]

Gets a lineage query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_lineage_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the lineage query. (required)

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

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

get_provenance(id, **kwargs)[source]

Gets a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the provenance query. (required)

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

  • summarize (bool) – Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

  • incremental_results (bool) – Whether or not to summarize provenance events returned. This property is false by default.

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

get_provenance_with_http_info(id, **kwargs)[source]

Gets a provenance query

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The id of the provenance query. (required)

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

  • summarize (bool) – Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

  • incremental_results (bool) – Whether or not to summarize provenance events returned. This property is false by default.

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

get_search_options(**kwargs)[source]

Gets the searchable attributes for provenance events

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_search_options(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ProvenanceOptionsEntity If the method is called asynchronously, returns the request thread.

get_search_options_with_http_info(**kwargs)[source]

Gets the searchable attributes for provenance events

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_search_options_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ProvenanceOptionsEntity If the method is called asynchronously, returns the request thread.

submit_lineage_request(body, **kwargs)[source]

Submits a lineage query Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_lineage_request(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (LineageEntity) – The lineage query details. (required)

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

submit_lineage_request_with_http_info(body, **kwargs)[source]

Submits a lineage query Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_lineage_request_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (LineageEntity) – The lineage query details. (required)

Returns:

LineageEntity If the method is called asynchronously, returns the request thread.

submit_provenance_request(body, **kwargs)[source]

Submits a provenance query Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_provenance_request(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ProvenanceEntity) – The provenance query details. (required)

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

submit_provenance_request_with_http_info(body, **kwargs)[source]

Submits a provenance query Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_provenance_request_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ProvenanceEntity) – The provenance query details. (required)

Returns:

ProvenanceEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.provenance_events_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.provenance_events_api.ProvenanceEventsApi(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

get_input_content(id, **kwargs)[source]

Gets the input content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_content(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The provenance event id. (required)

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

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_input_content_with_http_info(id, **kwargs)[source]

Gets the input content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_input_content_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The provenance event id. (required)

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

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_output_content(id, **kwargs)[source]

Gets the output content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_content(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The provenance event id. (required)

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

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_output_content_with_http_info(id, **kwargs)[source]

Gets the output content for a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_output_content_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The provenance event id. (required)

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

Returns:

StreamingOutput If the method is called asynchronously, returns the request thread.

get_provenance_event(id, **kwargs)[source]

Gets a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance_event(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The provenance event id. (required)

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

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

get_provenance_event_with_http_info(id, **kwargs)[source]

Gets a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_provenance_event_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The provenance event id. (required)

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

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

submit_replay(body, **kwargs)[source]

Replays content from a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_replay(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (SubmitReplayRequestEntity) – The replay request. (required)

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

submit_replay_latest_event(body, **kwargs)[source]

Replays content from a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_replay_latest_event(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ReplayLastEventRequestEntity) – The replay request. (required)

Returns:

ReplayLastEventResponseEntity If the method is called asynchronously, returns the request thread.

submit_replay_latest_event_with_http_info(body, **kwargs)[source]

Replays content from a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_replay_latest_event_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (ReplayLastEventRequestEntity) – The replay request. (required)

Returns:

ReplayLastEventResponseEntity If the method is called asynchronously, returns the request thread.

submit_replay_with_http_info(body, **kwargs)[source]

Replays content from a provenance event

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_replay_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (SubmitReplayRequestEntity) – The replay request. (required)

Returns:

ProvenanceEventEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.remote_process_groups_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.remote_process_groups_api.RemoteProcessGroupsApi(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

get_remote_process_group(id, **kwargs)[source]

Gets a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_remote_process_group_with_http_info(id, **kwargs)[source]

Gets a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_remote_process_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)[source]

Gets the state for a RemoteProcessGroup

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)[source]

Gets the state for a RemoteProcessGroup

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

remove_remote_process_group(id, **kwargs)[source]

Deletes a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_remote_process_group(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

remove_remote_process_group_with_http_info(id, **kwargs)[source]

Deletes a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_remote_process_group_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group(id, body, **kwargs)[source]

Updates a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • body (RemoteProcessGroupEntity) – The remote process group. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port(id, port_id, body, **kwargs)[source]

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port_run_status(id, port_id, body, **kwargs)[source]

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port_run_status(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, **kwargs)[source]

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port_run_status_with_http_info(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_input_port_with_http_info(id, port_id, body, **kwargs)[source]

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_input_port_with_http_info(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port(id, port_id, body, **kwargs)[source]

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port_run_status(id, port_id, body, **kwargs)[source]

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port_run_status(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, **kwargs)[source]

Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port_run_status_with_http_info(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemotePortRunStatusEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_output_port_with_http_info(id, port_id, body, **kwargs)[source]

Updates a remote port Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_output_port_with_http_info(id, port_id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • port_id (str) – The remote process group port id. (required)

  • body (RemoteProcessGroupPortEntity) – The remote process group port. (required)

Returns:

RemoteProcessGroupPortEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_status(id, body, **kwargs)[source]

Updates run status of a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_status(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • body (RemotePortRunStatusEntity) – The remote process group run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_status_with_http_info(id, body, **kwargs)[source]

Updates run status of a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_status_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • body (RemotePortRunStatusEntity) – The remote process group run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_statuses(id, body, **kwargs)[source]

Updates run status of all remote process groups in a process group (recursively)

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_statuses(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (RemotePortRunStatusEntity) – The remote process groups run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_run_statuses_with_http_info(id, body, **kwargs)[source]

Updates run status of all remote process groups in a process group (recursively)

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_run_statuses_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The process group id. (required)

  • body (RemotePortRunStatusEntity) – The remote process groups run status. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

update_remote_process_group_with_http_info(id, body, **kwargs)[source]

Updates a remote process group

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_remote_process_group_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The remote process group id. (required)

  • body (RemoteProcessGroupEntity) – The remote process group. (required)

Returns:

RemoteProcessGroupEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.reporting_tasks_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.reporting_tasks_api.ReportingTasksApi(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

analyze_configuration(id, body, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

analyze_configuration_with_http_info(id, body, **kwargs)[source]

Performs analysis of the component’s configuration, providing information about which attributes are referenced.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.analyze_configuration_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (ConfigurationAnalysisEntity) – The configuration analysis request. (required)

Returns:

ConfigurationAnalysisEntity If the method is called asynchronously, returns the request thread.

clear_state(id, **kwargs)[source]

Clears the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

clear_state_with_http_info(id, **kwargs)[source]

Clears the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.clear_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

delete_verification_request(id, request_id, **kwargs)[source]

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Reporting Task (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

delete_verification_request_with_http_info(id, request_id, **kwargs)[source]

Deletes the Verification Request with the given ID Deletes the Verification Request with the given ID. After a request is created, it is expected that the client will properly clean up the request by DELETE’ing it, once the Verification process has completed. If the request is deleted before the request completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Reporting Task (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor(id, property_name, **kwargs)[source]

Gets a reporting task property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • property_name (str) – The property name. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_property_descriptor_with_http_info(id, property_name, **kwargs)[source]

Gets a reporting task property descriptor

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_property_descriptor_with_http_info(id, property_name, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • property_name (str) – The property name. (required)

  • sensitive (bool) – Property Descriptor requested sensitive status

Returns:

PropertyDescriptorEntity If the method is called asynchronously, returns the request thread.

get_reporting_task(id, **kwargs)[source]

Gets a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

get_reporting_task_with_http_info(id, **kwargs)[source]

Gets a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_reporting_task_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

get_state(id, **kwargs)[source]

Gets the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_state_with_http_info(id, **kwargs)[source]

Gets the state for a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_state_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

Returns:

ComponentStateEntity If the method is called asynchronously, returns the request thread.

get_verification_request(id, request_id, **kwargs)[source]

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Reporting Task (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

get_verification_request_with_http_info(id, request_id, **kwargs)[source]

Returns the Verification Request with the given ID Returns the Verification Request with the given ID. Once an Verification Request has been created, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_verification_request_with_http_info(id, request_id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The ID of the Reporting Task (required)

  • request_id (str) – The ID of the Verification Request (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

remove_reporting_task(id, **kwargs)[source]

Deletes a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_reporting_task(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

remove_reporting_task_with_http_info(id, **kwargs)[source]

Deletes a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.remove_reporting_task_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • version (str) – The revision is used to verify the client is working with the latest version of the flow.

  • client_id (str) – If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request(id, body, **kwargs)[source]

Performs verification of the Reporting Task’s configuration This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (VerifyConfigRequestEntity) – The reporting task configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

submit_config_verification_request_with_http_info(id, body, **kwargs)[source]

Performs verification of the Reporting Task’s configuration This will initiate the process of verifying a given Reporting Task configuration. This may be a long-running task. As a result, this endpoint will immediately return a ReportingTaskConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /reporting-tasks/{taskId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /reporting-tasks/{serviceId}/verification-requests/{requestId}. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.submit_config_verification_request_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (VerifyConfigRequestEntity) – The reporting task configuration verification request. (required)

Returns:

VerifyConfigRequestEntity If the method is called asynchronously, returns the request thread.

update_reporting_task(id, body, **kwargs)[source]

Updates a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_reporting_task(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

update_reporting_task_with_http_info(id, body, **kwargs)[source]

Updates a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_reporting_task_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (ReportingTaskEntity) – The reporting task configuration details. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

update_run_status(id, body, **kwargs)[source]

Updates run status of a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (ReportingTaskRunStatusEntity) – The reporting task run status. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

update_run_status_with_http_info(id, body, **kwargs)[source]

Updates run status of a reporting task

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_run_status_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • id (str) – The reporting task id. (required)

  • body (ReportingTaskRunStatusEntity) – The reporting task run status. (required)

Returns:

ReportingTaskEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.resources_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.resources_api.ResourcesApi(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

get_resources(**kwargs)[source]

Gets the available resources that support access/authorization policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ResourcesEntity If the method is called asynchronously, returns the request thread.

get_resources_with_http_info(**kwargs)[source]

Gets the available resources that support access/authorization policies

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_resources_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ResourcesEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.site_to_site_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.site_to_site_api.SiteToSiteApi(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

get_peers(**kwargs)[source]

Returns the available Peers and its status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_peers(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

PeersEntity If the method is called asynchronously, returns the request thread.

get_peers_with_http_info(**kwargs)[source]

Returns the available Peers and its status of this NiFi

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_peers_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

PeersEntity If the method is called asynchronously, returns the request thread.

get_site_to_site_details(**kwargs)[source]

Returns the details about this NiFi necessary to communicate via site to site

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_site_to_site_details(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerEntity If the method is called asynchronously, returns the request thread.

get_site_to_site_details_with_http_info(**kwargs)[source]

Returns the details about this NiFi necessary to communicate via site to site

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_site_to_site_details_with_http_info(callback=callback_function)

Parameters:

function (callback) – The callback function for asynchronous request. (optional)

Returns:

ControllerEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.snippets_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.snippets_api.SnippetsApi(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

create_snippet(body, **kwargs)[source]

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_snippet(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

create_snippet_with_http_info(body, **kwargs)[source]

Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.create_snippet_with_http_info(body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

delete_snippet(id, **kwargs)[source]

Deletes the components in a snippet and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_snippet(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

delete_snippet_with_http_info(id, **kwargs)[source]

Deletes the components in a snippet and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.delete_snippet_with_http_info(id, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • disconnected_node_acknowledged (bool) – Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

update_snippet(id, body, **kwargs)[source]

Move’s the components in this Snippet into a new Process Group and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_snippet(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

update_snippet_with_http_info(id, body, **kwargs)[source]

Move’s the components in this Snippet into a new Process Group and discards the snippet

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.update_snippet_with_http_info(id, body, callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

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

  • body (SnippetEntity) – The snippet configuration details. (required)

Returns:

SnippetEntity If the method is called asynchronously, returns the request thread.

nipyapi.nifi.apis.system_diagnostics_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.apis.system_diagnostics_api.SystemDiagnosticsApi(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

get_jmx_metrics(**kwargs)[source]

Retrieve available JMX metrics Note: This endpoint is subject to change as NiFi and it’s REST API evolve. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response. >>> def callback_function(response): >>> pprint(response) >>> >>> thread = api.get_jmx_metrics(callback=callback_function)

Parameters:
  • function (callback) – The callback function for asynchronous request. (optional)

  • bean_name_filter (str) – Regular Expression Pattern to be applied against the ObjectName

Returns:

JmxMetricsResultsEntity If the method is called asynchronously, returns the request thread.

get_jmx_metrics_with_http_info(**kwargs)[source]

Retrieve available JMX metrics Note: T