Apache NiFi REST API

REST API definition for Apache NiFi web services

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

class nipyapi.nifi.apis.counters_api.CountersApi(api_client=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)

get_counters(**kwargs)

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 and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_counters_with_http_info() method instead.

Parameters:

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

The response data.

Return type:

CountersEntity

get_counters_with_http_info(**kwargs)

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 and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_counters() method instead.

Parameters:

• 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, status_code, headers) - Response data with HTTP details.

Return type:

tuple

update_all_counters(**kwargs)

Updates all counters. This will reset all counter values to 0.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding update_all_counters_with_http_info() method instead.

Args:

Returns:

The response data.

Return type:

CountersEntity

update_all_counters_with_http_info(**kwargs)

Updates all counters. This will reset all counter values to 0.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding update_all_counters() method instead.

Args:

Returns:

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

Return type:

tuple

update_counter(id, **kwargs)

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 and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding update_counter_with_http_info() method instead.

Parameters:

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

Returns:

The response data.

Return type:

CounterEntity

update_counter_with_http_info(id, **kwargs)

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 and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding update_counter() method instead.

Parameters:

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

Returns:

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

Return type:

tuple