All URIs are relative to http://localhost/nifi-api
Method | HTTP request | Description |
---|---|---|
activateControllerServices | PUT /flow/process-groups/{id}/controller-services | Enable or disable Controller Services in the specified Process Group. |
generateClientId | GET /flow/client-id | Generates a client id. |
getAboutInfo | GET /flow/about | Retrieves details about this NiFi to put in the About dialog |
getAction | GET /flow/history/{id} | Gets an action |
getBanners | GET /flow/banners | Retrieves the banners for this NiFi |
getBuckets | GET /flow/registries/{id}/buckets | Gets the buckets from the specified registry for the current user |
getBulletinBoard | GET /flow/bulletin-board | Gets current bulletins |
getBulletins | GET /flow/controller/bulletins | Retrieves Controller level bulletins |
getClusterSummary | GET /flow/cluster/summary | The cluster summary for this NiFi |
getComponentHistory | GET /flow/history/components/{componentId} | Gets configuration history for a component |
getConnectionStatistics | GET /flow/connections/{id}/statistics | Gets statistics for a connection |
getConnectionStatus | GET /flow/connections/{id}/status | Gets status for a connection |
getConnectionStatusHistory | GET /flow/connections/{id}/status/history | Gets the status history for a connection |
getControllerServiceTypes | GET /flow/controller-service-types | Retrieves the types of controller services that this NiFi supports |
getControllerServicesFromController | GET /flow/controller/controller-services | Gets controller services for reporting tasks |
getControllerServicesFromGroup | GET /flow/process-groups/{id}/controller-services | Gets all controller services |
getControllerStatus | GET /flow/status | Gets the current status of this NiFi |
getCurrentUser | GET /flow/current-user | Retrieves the user identity of the user making the request |
getDetails | GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details | Gets the details of a flow from the specified registry and bucket for the specified flow for the current user |
getFlow | GET /flow/process-groups/{id} | Gets a process group |
getFlowConfig | GET /flow/config | Retrieves the configuration for this NiFi flow |
getFlowMetrics | GET /flow/metrics/{producer} | Gets all metrics for the flow from a particular node |
getFlows | GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows | Gets the flows from the specified registry and bucket for the current user |
getInputPortStatus | GET /flow/input-ports/{id}/status | Gets status for an input port |
getOutputPortStatus | GET /flow/output-ports/{id}/status | Gets status for an output port |
getParameterContexts | GET /flow/parameter-contexts | Gets all Parameter Contexts |
getParameterProviderTypes | GET /flow/parameter-provider-types | Retrieves the types of parameter providers that this NiFi supports |
getParameterProviders | GET /flow/parameter-providers | Gets all parameter providers |
getPrioritizers | GET /flow/prioritizers | Retrieves the types of prioritizers that this NiFi supports |
getProcessGroupStatus | GET /flow/process-groups/{id}/status | Gets the status for a process group |
getProcessGroupStatusHistory | GET /flow/process-groups/{id}/status/history | Gets status history for a remote process group |
getProcessorStatus | GET /flow/processors/{id}/status | Gets status for a processor |
getProcessorStatusHistory | GET /flow/processors/{id}/status/history | Gets status history for a processor |
getProcessorTypes | GET /flow/processor-types | Retrieves the types of processors that this NiFi supports |
getRegistryClients | GET /flow/registries | Gets the listing of available flow registry clients |
getRemoteProcessGroupStatus | GET /flow/remote-process-groups/{id}/status | Gets status for a remote process group |
getRemoteProcessGroupStatusHistory | GET /flow/remote-process-groups/{id}/status/history | Gets the status history |
getReportingTaskTypes | GET /flow/reporting-task-types | Retrieves the types of reporting tasks that this NiFi supports |
getReportingTasks | GET /flow/reporting-tasks | Gets all reporting tasks |
getRuntimeManifest | GET /flow/runtime-manifest | Retrieves the runtime manifest for this NiFi instance. |
getTemplates | GET /flow/templates | Gets all templates |
getVersions | GET /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions | Gets the flow versions from the specified registry and bucket for the specified flow for the current user |
queryHistory | GET /flow/history | Gets configuration history |
scheduleComponents | PUT /flow/process-groups/{id} | Schedule or unschedule components in the specified Process Group. |
searchCluster | GET /flow/cluster/search-results | Searches the cluster for a node with the specified address |
searchFlow | GET /flow/search-results | Performs a search against this NiFi using the specified search term |
ActivateControllerServicesEntity activateControllerServices(id, body)
Enable or disable Controller Services in the specified Process Group.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
ActivateControllerServicesEntity body = new ActivateControllerServicesEntity(); // ActivateControllerServicesEntity | The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.
try {
ActivateControllerServicesEntity result = apiInstance.activateControllerServices(id, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#activateControllerServices");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The process group id. | |
body | ActivateControllerServicesEntity | The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. |
ActivateControllerServicesEntity
No authorization required
- Content-Type: application/json
- Accept: application/json
String generateClientId()
Generates a client id.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
String result = apiInstance.generateClientId();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#generateClientId");
e.printStackTrace();
}
This endpoint does not need any parameter.
String
No authorization required
- Content-Type: /
- Accept: text/plain
AboutEntity getAboutInfo()
Retrieves details about this NiFi to put in the About dialog
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
AboutEntity result = apiInstance.getAboutInfo();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getAboutInfo");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
ActionEntity getAction(id)
Gets an action
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The action id.
try {
ActionEntity result = apiInstance.getAction(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getAction");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The action id. |
No authorization required
- Content-Type: /
- Accept: application/json
BannerEntity getBanners()
Retrieves the banners for this NiFi
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
BannerEntity result = apiInstance.getBanners();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getBanners");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
FlowRegistryBucketsEntity getBuckets(id)
Gets the buckets from the specified registry for the current user
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The registry id.
try {
FlowRegistryBucketsEntity result = apiInstance.getBuckets(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getBuckets");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The registry id. |
No authorization required
- Content-Type: /
- Accept: application/json
BulletinBoardEntity getBulletinBoard(after, sourceName, message, sourceId, groupId, limit)
Gets current bulletins
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String after = "after_example"; // String | Includes bulletins with an id after this value.
String sourceName = "sourceName_example"; // String | Includes bulletins originating from this sources whose name match this regular expression.
String message = "message_example"; // String | Includes bulletins whose message that match this regular expression.
String sourceId = "sourceId_example"; // String | Includes bulletins originating from this sources whose id match this regular expression.
String groupId = "groupId_example"; // String | Includes bulletins originating from this sources whose group id match this regular expression.
String limit = "limit_example"; // String | The number of bulletins to limit the response to.
try {
BulletinBoardEntity result = apiInstance.getBulletinBoard(after, sourceName, message, sourceId, groupId, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getBulletinBoard");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
after | String | Includes bulletins with an id after this value. | [optional] |
sourceName | String | Includes bulletins originating from this sources whose name match this regular expression. | [optional] |
message | String | Includes bulletins whose message that match this regular expression. | [optional] |
sourceId | String | Includes bulletins originating from this sources whose id match this regular expression. | [optional] |
groupId | String | Includes bulletins originating from this sources whose group id match this regular expression. | [optional] |
limit | String | The number of bulletins to limit the response to. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
ControllerBulletinsEntity getBulletins()
Retrieves Controller level bulletins
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
ControllerBulletinsEntity result = apiInstance.getBulletins();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getBulletins");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
ClusteSummaryEntity getClusterSummary()
The cluster summary for this NiFi
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
ClusteSummaryEntity result = apiInstance.getClusterSummary();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getClusterSummary");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
ComponentHistoryEntity getComponentHistory(componentId)
Gets configuration history for a component
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String componentId = "componentId_example"; // String | The component id.
try {
ComponentHistoryEntity result = apiInstance.getComponentHistory(componentId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getComponentHistory");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
componentId | String | The component id. |
No authorization required
- Content-Type: /
- Accept: application/json
ConnectionStatisticsEntity getConnectionStatistics(id, nodewise, clusterNodeId)
Gets statistics for a connection
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The connection id.
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 statistics.
try {
ConnectionStatisticsEntity result = apiInstance.getConnectionStatistics(id, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getConnectionStatistics");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The connection id. | |
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 statistics. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
ConnectionStatusEntity getConnectionStatus(id, nodewise, clusterNodeId)
Gets status for a connection
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The connection id.
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 {
ConnectionStatusEntity result = apiInstance.getConnectionStatus(id, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getConnectionStatus");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The connection id. | |
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] |
No authorization required
- Content-Type: /
- Accept: application/json
StatusHistoryEntity getConnectionStatusHistory(id)
Gets the status history for a connection
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The connection id.
try {
StatusHistoryEntity result = apiInstance.getConnectionStatusHistory(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getConnectionStatusHistory");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The connection id. |
No authorization required
- Content-Type: /
- Accept: application/json
ControllerServiceTypesEntity getControllerServiceTypes(serviceType, serviceBundleGroup, serviceBundleArtifact, serviceBundleVersion, bundleGroupFilter, bundleArtifactFilter, typeFilter)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String serviceType = "serviceType_example"; // String | If specified, will only return controller services that are compatible with this type of service.
String serviceBundleGroup = "serviceBundleGroup_example"; // String | If serviceType specified, is the bundle group of the serviceType.
String serviceBundleArtifact = "serviceBundleArtifact_example"; // String | If serviceType specified, is the bundle artifact of the serviceType.
String serviceBundleVersion = "serviceBundleVersion_example"; // String | If serviceType specified, is the bundle version of the serviceType.
String bundleGroupFilter = "bundleGroupFilter_example"; // String | If specified, will only return types that are a member of this bundle group.
String bundleArtifactFilter = "bundleArtifactFilter_example"; // String | If specified, will only return types that are a member of this bundle artifact.
String typeFilter = "typeFilter_example"; // String | If specified, will only return types whose fully qualified classname matches.
try {
ControllerServiceTypesEntity result = apiInstance.getControllerServiceTypes(serviceType, serviceBundleGroup, serviceBundleArtifact, serviceBundleVersion, bundleGroupFilter, bundleArtifactFilter, typeFilter);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getControllerServiceTypes");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
serviceType | String | If specified, will only return controller services that are compatible with this type of service. | [optional] |
serviceBundleGroup | String | If serviceType specified, is the bundle group of the serviceType. | [optional] |
serviceBundleArtifact | String | If serviceType specified, is the bundle artifact of the serviceType. | [optional] |
serviceBundleVersion | String | If serviceType specified, is the bundle version of the serviceType. | [optional] |
bundleGroupFilter | String | If specified, will only return types that are a member of this bundle group. | [optional] |
bundleArtifactFilter | String | If specified, will only return types that are a member of this bundle artifact. | [optional] |
typeFilter | String | If specified, will only return types whose fully qualified classname matches. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
ControllerServicesEntity getControllerServicesFromController(uiOnly)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
Boolean uiOnly = false; // Boolean |
try {
ControllerServicesEntity result = apiInstance.getControllerServicesFromController(uiOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getControllerServicesFromController");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
uiOnly | Boolean | [optional] [default to false] |
No authorization required
- Content-Type: /
- Accept: application/json
ControllerServicesEntity getControllerServicesFromGroup(id, includeAncestorGroups, includeDescendantGroups, uiOnly)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
Boolean includeAncestorGroups = true; // Boolean | Whether or not to include parent/ancestory process groups
Boolean includeDescendantGroups = false; // Boolean | Whether or not to include descendant process groups
Boolean uiOnly = false; // Boolean |
try {
ControllerServicesEntity result = apiInstance.getControllerServicesFromGroup(id, includeAncestorGroups, includeDescendantGroups, uiOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getControllerServicesFromGroup");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The process group id. | |
includeAncestorGroups | Boolean | Whether or not to include parent/ancestory process groups | [optional] [default to true] |
includeDescendantGroups | Boolean | Whether or not to include descendant process groups | [optional] [default to false] |
uiOnly | Boolean | [optional] [default to false] |
No authorization required
- Content-Type: /
- Accept: application/json
ControllerStatusEntity getControllerStatus()
Gets the current status of this NiFi
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
ControllerStatusEntity result = apiInstance.getControllerStatus();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getControllerStatus");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
CurrentUserEntity getCurrentUser()
Retrieves the user identity of the user making the request
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
CurrentUserEntity result = apiInstance.getCurrentUser();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getCurrentUser");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
VersionedFlowEntity getDetails(registryId, bucketId, flowId)
Gets the details of a flow from the specified registry and bucket for the specified flow for the current user
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String registryId = "registryId_example"; // String | The registry client id.
String bucketId = "bucketId_example"; // String | The bucket id.
String flowId = "flowId_example"; // String | The flow id.
try {
VersionedFlowEntity result = apiInstance.getDetails(registryId, bucketId, flowId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getDetails");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
registryId | String | The registry client id. | |
bucketId | String | The bucket id. | |
flowId | String | The flow id. |
No authorization required
- Content-Type: /
- Accept: application/json
ProcessGroupFlowEntity getFlow(id, uiOnly)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
Boolean uiOnly = false; // Boolean |
try {
ProcessGroupFlowEntity result = apiInstance.getFlow(id, uiOnly);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getFlow");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The process group id. | |
uiOnly | Boolean | [optional] [default to false] |
No authorization required
- Content-Type: /
- Accept: application/json
FlowConfigurationEntity getFlowConfig()
Retrieves the configuration for this NiFi flow
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
FlowConfigurationEntity result = apiInstance.getFlowConfig();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getFlowConfig");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
StreamingOutput getFlowMetrics(producer, includedRegistries, sampleName, sampleLabelValue, rootFieldName)
Gets all metrics for the flow from a particular node
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String producer = "producer_example"; // String | The producer for flow file metrics. Each producer may have its own output format.
List<String> includedRegistries = Arrays.asList("includedRegistries_example"); // List<String> | Set of included metrics registries
String sampleName = "sampleName_example"; // String | Regular Expression Pattern to be applied against the sample name field
String sampleLabelValue = "sampleLabelValue_example"; // String | Regular Expression Pattern to be applied against the sample label value field
String rootFieldName = "rootFieldName_example"; // String | Name of the first field of JSON object. Applicable for JSON producer only.
try {
StreamingOutput result = apiInstance.getFlowMetrics(producer, includedRegistries, sampleName, sampleLabelValue, rootFieldName);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getFlowMetrics");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
producer | String | The producer for flow file metrics. Each producer may have its own output format. | [enum: prometheus] |
includedRegistries | List<String> | Set of included metrics registries | [optional] [enum: NIFI, JVM, BULLETIN, CONNECTION] |
sampleName | String | Regular Expression Pattern to be applied against the sample name field | [optional] |
sampleLabelValue | String | Regular Expression Pattern to be applied against the sample label value field | [optional] |
rootFieldName | String | Name of the first field of JSON object. Applicable for JSON producer only. | [optional] |
No authorization required
- Content-Type: /
- Accept: /
VersionedFlowsEntity getFlows(registryId, bucketId)
Gets the flows from the specified registry and bucket for the current user
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String registryId = "registryId_example"; // String | The registry client id.
String bucketId = "bucketId_example"; // String | The bucket id.
try {
VersionedFlowsEntity result = apiInstance.getFlows(registryId, bucketId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getFlows");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
registryId | String | The registry client id. | |
bucketId | String | The bucket id. |
No authorization required
- Content-Type: /
- Accept: application/json
PortStatusEntity getInputPortStatus(id, nodewise, clusterNodeId)
Gets status for an input port
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The input port id.
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 {
PortStatusEntity result = apiInstance.getInputPortStatus(id, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getInputPortStatus");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The input port id. | |
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] |
No authorization required
- Content-Type: /
- Accept: application/json
PortStatusEntity getOutputPortStatus(id, nodewise, clusterNodeId)
Gets status for an output port
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The output port id.
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 {
PortStatusEntity result = apiInstance.getOutputPortStatus(id, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getOutputPortStatus");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The output port id. | |
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] |
No authorization required
- Content-Type: /
- Accept: application/json
ParameterContextsEntity getParameterContexts()
Gets all Parameter Contexts
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
ParameterContextsEntity result = apiInstance.getParameterContexts();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getParameterContexts");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
ParameterProviderTypesEntity getParameterProviderTypes(bundleGroupFilter, bundleArtifactFilter, type)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String bundleGroupFilter = "bundleGroupFilter_example"; // String | If specified, will only return types that are a member of this bundle group.
String bundleArtifactFilter = "bundleArtifactFilter_example"; // String | If specified, will only return types that are a member of this bundle artifact.
String type = "type_example"; // String | If specified, will only return types whose fully qualified classname matches.
try {
ParameterProviderTypesEntity result = apiInstance.getParameterProviderTypes(bundleGroupFilter, bundleArtifactFilter, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getParameterProviderTypes");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
bundleGroupFilter | String | If specified, will only return types that are a member of this bundle group. | [optional] |
bundleArtifactFilter | String | If specified, will only return types that are a member of this bundle artifact. | [optional] |
type | String | If specified, will only return types whose fully qualified classname matches. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
ParameterProvidersEntity getParameterProviders()
Gets all parameter providers
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
ParameterProvidersEntity result = apiInstance.getParameterProviders();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getParameterProviders");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
PrioritizerTypesEntity getPrioritizers()
Retrieves the types of prioritizers that this NiFi supports
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
PrioritizerTypesEntity result = apiInstance.getPrioritizers();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getPrioritizers");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
ProcessGroupStatusEntity getProcessGroupStatus(id, recursive, nodewise, clusterNodeId)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
Boolean recursive = false; // Boolean | Whether all descendant groups and the status of their content will be included. Optional, defaults to false
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 {
ProcessGroupStatusEntity result = apiInstance.getProcessGroupStatus(id, recursive, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getProcessGroupStatus");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The process group id. | |
recursive | Boolean | Whether all descendant groups and the status of their content will be included. Optional, defaults to false | [optional] [default to false] |
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] |
No authorization required
- Content-Type: /
- Accept: application/json
StatusHistoryEntity getProcessGroupStatusHistory(id)
Gets status history for a remote process group
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
try {
StatusHistoryEntity result = apiInstance.getProcessGroupStatusHistory(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getProcessGroupStatusHistory");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The process group id. |
No authorization required
- Content-Type: /
- Accept: application/json
ProcessorStatusEntity getProcessorStatus(id, nodewise, clusterNodeId)
Gets status for a processor
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The processor id.
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 {
ProcessorStatusEntity result = apiInstance.getProcessorStatus(id, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getProcessorStatus");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The processor id. | |
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] |
No authorization required
- Content-Type: /
- Accept: application/json
StatusHistoryEntity getProcessorStatusHistory(id)
Gets status history for a processor
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The processor id.
try {
StatusHistoryEntity result = apiInstance.getProcessorStatusHistory(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getProcessorStatusHistory");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The processor id. |
No authorization required
- Content-Type: /
- Accept: application/json
ProcessorTypesEntity getProcessorTypes(bundleGroupFilter, bundleArtifactFilter, type)
Retrieves the types of processors that this NiFi supports
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String bundleGroupFilter = "bundleGroupFilter_example"; // String | If specified, will only return types that are a member of this bundle group.
String bundleArtifactFilter = "bundleArtifactFilter_example"; // String | If specified, will only return types that are a member of this bundle artifact.
String type = "type_example"; // String | If specified, will only return types whose fully qualified classname matches.
try {
ProcessorTypesEntity result = apiInstance.getProcessorTypes(bundleGroupFilter, bundleArtifactFilter, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getProcessorTypes");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
bundleGroupFilter | String | If specified, will only return types that are a member of this bundle group. | [optional] |
bundleArtifactFilter | String | If specified, will only return types that are a member of this bundle artifact. | [optional] |
type | String | If specified, will only return types whose fully qualified classname matches. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
FlowRegistryClientsEntity getRegistryClients()
Gets the listing of available flow registry clients
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
FlowRegistryClientsEntity result = apiInstance.getRegistryClients();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getRegistryClients");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
RemoteProcessGroupStatusEntity getRemoteProcessGroupStatus(id, nodewise, clusterNodeId)
Gets status for a remote process group
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The remote process group id.
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 {
RemoteProcessGroupStatusEntity result = apiInstance.getRemoteProcessGroupStatus(id, nodewise, clusterNodeId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getRemoteProcessGroupStatus");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The remote process group id. | |
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] |
RemoteProcessGroupStatusEntity
No authorization required
- Content-Type: /
- Accept: application/json
StatusHistoryEntity getRemoteProcessGroupStatusHistory(id)
Gets the status history
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The remote process group id.
try {
StatusHistoryEntity result = apiInstance.getRemoteProcessGroupStatusHistory(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getRemoteProcessGroupStatusHistory");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The remote process group id. |
No authorization required
- Content-Type: /
- Accept: application/json
ReportingTaskTypesEntity getReportingTaskTypes(bundleGroupFilter, bundleArtifactFilter, type)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String bundleGroupFilter = "bundleGroupFilter_example"; // String | If specified, will only return types that are a member of this bundle group.
String bundleArtifactFilter = "bundleArtifactFilter_example"; // String | If specified, will only return types that are a member of this bundle artifact.
String type = "type_example"; // String | If specified, will only return types whose fully qualified classname matches.
try {
ReportingTaskTypesEntity result = apiInstance.getReportingTaskTypes(bundleGroupFilter, bundleArtifactFilter, type);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getReportingTaskTypes");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
bundleGroupFilter | String | If specified, will only return types that are a member of this bundle group. | [optional] |
bundleArtifactFilter | String | If specified, will only return types that are a member of this bundle artifact. | [optional] |
type | String | If specified, will only return types whose fully qualified classname matches. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
ReportingTasksEntity getReportingTasks()
Gets all reporting tasks
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
ReportingTasksEntity result = apiInstance.getReportingTasks();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getReportingTasks");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
RuntimeManifestEntity getRuntimeManifest()
Retrieves the runtime manifest for this NiFi instance.
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
RuntimeManifestEntity result = apiInstance.getRuntimeManifest();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getRuntimeManifest");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
TemplatesEntity getTemplates()
Gets all templates
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
try {
TemplatesEntity result = apiInstance.getTemplates();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getTemplates");
e.printStackTrace();
}
This endpoint does not need any parameter.
No authorization required
- Content-Type: /
- Accept: application/json
VersionedFlowSnapshotMetadataSetEntity getVersions(registryId, bucketId, flowId)
Gets the flow versions from the specified registry and bucket for the specified flow for the current user
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String registryId = "registryId_example"; // String | The registry client id.
String bucketId = "bucketId_example"; // String | The bucket id.
String flowId = "flowId_example"; // String | The flow id.
try {
VersionedFlowSnapshotMetadataSetEntity result = apiInstance.getVersions(registryId, bucketId, flowId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#getVersions");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
registryId | String | The registry client id. | |
bucketId | String | The bucket id. | |
flowId | String | The flow id. |
VersionedFlowSnapshotMetadataSetEntity
No authorization required
- Content-Type: /
- Accept: application/json
HistoryEntity queryHistory(offset, count, sortColumn, sortOrder, startDate, endDate, userIdentity, sourceId)
Gets configuration history
Note: This endpoint is subject to change as NiFi and it's REST API evolve.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String offset = "offset_example"; // String | The offset into the result set.
String count = "count_example"; // String | The number of actions to return.
String sortColumn = "sortColumn_example"; // String | The field to sort on.
String sortOrder = "sortOrder_example"; // String | The direction to sort.
String startDate = "startDate_example"; // String | Include actions after this date.
String endDate = "endDate_example"; // String | Include actions before this date.
String userIdentity = "userIdentity_example"; // String | Include actions performed by this user.
String sourceId = "sourceId_example"; // String | Include actions on this component.
try {
HistoryEntity result = apiInstance.queryHistory(offset, count, sortColumn, sortOrder, startDate, endDate, userIdentity, sourceId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#queryHistory");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
offset | String | The offset into the result set. | |
count | String | The number of actions to return. | |
sortColumn | String | The field to sort on. | [optional] |
sortOrder | String | The direction to sort. | [optional] |
startDate | String | Include actions after this date. | [optional] |
endDate | String | Include actions before this date. | [optional] |
userIdentity | String | Include actions performed by this user. | [optional] |
sourceId | String | Include actions on this component. | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json
ScheduleComponentsEntity scheduleComponents(id, body)
Schedule or unschedule components in the specified Process Group.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String id = "id_example"; // String | The process group id.
ScheduleComponentsEntity body = new ScheduleComponentsEntity(); // ScheduleComponentsEntity | The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.
try {
ScheduleComponentsEntity result = apiInstance.scheduleComponents(id, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#scheduleComponents");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | String | The process group id. | |
body | ScheduleComponentsEntity | The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. |
No authorization required
- Content-Type: application/json
- Accept: application/json
ClusterSearchResultsEntity searchCluster(q)
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.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String q = "q_example"; // String | Node address to search for.
try {
ClusterSearchResultsEntity result = apiInstance.searchCluster(q);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#searchCluster");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
q | String | Node address to search for. |
No authorization required
- Content-Type: /
- Accept: application/json
SearchResultsEntity searchFlow(q, a)
Performs a search against this NiFi using the specified search term
Only search results from authorized components will be returned.
// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowApi;
FlowApi apiInstance = new FlowApi();
String q = "q_example"; // String |
String a = "a_example"; // String |
try {
SearchResultsEntity result = apiInstance.searchFlow(q, a);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling FlowApi#searchFlow");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
q | String | [optional] | |
a | String | [optional] |
No authorization required
- Content-Type: /
- Accept: application/json