Skip to content

CountersApi.md

Latest commit

 

History

History
102 lines (70 loc) · 2.78 KB

CountersApi.md

File metadata and controls

102 lines (70 loc) · 2.78 KB

CountersApi

All URIs are relative to http://localhost/nifi-api

Method HTTP request Description
getCounters GET /counters Gets the current counters for this NiFi
updateCounter PUT /counters/{id} Updates the specified counter. This will reset the counter value to 0

getCounters

CountersEntity getCounters(nodewise, clusterNodeId)

Gets the current counters for this NiFi

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CountersApi;


CountersApi apiInstance = new CountersApi();
Boolean nodewise = false; // Boolean | Whether or not to include the breakdown per node. Optional, defaults to false
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where to get the status.
try {
    CountersEntity result = apiInstance.getCounters(nodewise, clusterNodeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CountersApi#getCounters");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
nodewise Boolean Whether or not to include the breakdown per node. Optional, defaults to false [optional] [default to false]
clusterNodeId String The id of the node where to get the status. [optional]

Return type

CountersEntity

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json

updateCounter

CounterEntity updateCounter(id)

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.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.CountersApi;


CountersApi apiInstance = new CountersApi();
String id = "id_example"; // String | The id of the counter.
try {
    CounterEntity result = apiInstance.updateCounter(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CountersApi#updateCounter");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The id of the counter.

Return type

CounterEntity

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: application/json