Package org.apache.nifi.toolkit.client
Interface FlowClient
- All Known Implementing Classes:
JerseyFlowClient
public interface FlowClient
Client for FlowResource.
-
Method Summary
Modifier and TypeMethodDescriptionactivateControllerServices(ActivateControllerServicesEntity activateControllerServicesEntity) Enable or disable controller services in the given process group.getConnectionStatus(String connectionId, boolean nodewise) Retrieves the status for the connection with the given IDRetrieves the controller services for the reporting tasks.getControllerServices(String groupId) Retrieves the controller services for the given group.Retrieves the available controller service types.getFlowRegistryBranches(String registryClientId) Returns the list of branches for the specified registry client IDgetFlowRegistryBuckets(String registryClientId, String branch) Returns the list of buckets in a given branch for the specified registry client IDgetFlowRegistryFlows(String registryClientId, String branch, String bucket) Returns the list of flows in a given branch and bucket for the specified registry client IDRetrieves the parameter providers.Retrieves the process group with the given id.getProcessGroupStatus(String groupId, boolean recursive) Retrieves the status for the process group with the given IDRetrieves the available processor types.Retrieves the reporting tasks.org.apache.nifi.flow.VersionedReportingTaskSnapshotRetrieves the snapshot of all reporting tasks and their respective controller services.org.apache.nifi.flow.VersionedReportingTaskSnapshotgetReportingTaskSnapshot(String reportingTaskId) Retrieves the snapshot of the given reporting task and it's respective controller services.Retrieves the available reporting task types.getSuggestedProcessGroupCoordinates(String parentId) Suggest a location for the new process group on a canvas, within a given process group.getVersions(String registryId, String bucketId, String flowId) Gets the possible versions for the given flow in the given bucket in the given registry.getVersions(String registryId, String bucketId, String flowId, String branch) Gets the possible versions for the given flow in the given bucket/branch in the given registry.scheduleProcessGroupComponents(String processGroupId, ScheduleComponentsEntity scheduleComponentsEntity) Schedules the components of a process group.
-
Method Details
-
getCurrentUser
- Returns:
- the entity representing the current user accessing the NiFi instance
- Throws:
NiFiClientExceptionIOException
-
getRootGroupId
- Returns:
- the id of the root process group
- Throws:
NiFiClientExceptionIOException
-
getProcessGroup
Retrieves the process group with the given id. Passing in "root" as the id will retrieve the root group.- Parameters:
id- the id of the process group to retrieve- Returns:
- the process group entity
- Throws:
NiFiClientExceptionIOException
-
getSuggestedProcessGroupCoordinates
ProcessGroupBox getSuggestedProcessGroupCoordinates(String parentId) throws NiFiClientException, IOException Suggest a location for the new process group on a canvas, within a given process group. Will locate to the right and then bottom and offset for the size of the PG box.- Parameters:
parentId- the id of the parent process group where the new process group will be located- Returns:
- the process group box where a new process group can be placed
- Throws:
NiFiClientExceptionIOException
-
scheduleProcessGroupComponents
ScheduleComponentsEntity scheduleProcessGroupComponents(String processGroupId, ScheduleComponentsEntity scheduleComponentsEntity) throws NiFiClientException, IOException Schedules the components of a process group.- Parameters:
processGroupId- the id of a process groupscheduleComponentsEntity- the scheduled state to update to- Returns:
- the entity representing the scheduled state
- Throws:
NiFiClientExceptionIOException
-
getVersions
VersionedFlowSnapshotMetadataSetEntity getVersions(String registryId, String bucketId, String flowId) throws NiFiClientException, IOException Gets the possible versions for the given flow in the given bucket in the given registry.- Parameters:
registryId- the id of the registry clientbucketId- the bucket idflowId- the flow id- Returns:
- the set of snapshot metadata entities
- Throws:
NiFiClientExceptionIOException
-
getVersions
VersionedFlowSnapshotMetadataSetEntity getVersions(String registryId, String bucketId, String flowId, String branch) throws NiFiClientException, IOException Gets the possible versions for the given flow in the given bucket/branch in the given registry.- Parameters:
registryId- the id of the registry clientbucketId- the bucket idflowId- the flow idbranch- the branch name- Returns:
- the set of snapshot metadata entities
- Throws:
NiFiClientExceptionIOException
-
getControllerServices
ControllerServicesEntity getControllerServices(String groupId) throws NiFiClientException, IOException Retrieves the controller services for the given group.- Parameters:
groupId- the process group id- Returns:
- the controller services entity
- Throws:
NiFiClientExceptionIOException
-
activateControllerServices
ActivateControllerServicesEntity activateControllerServices(ActivateControllerServicesEntity activateControllerServicesEntity) throws NiFiClientException, IOException Enable or disable controller services in the given process group.- Parameters:
activateControllerServicesEntity- the entity indicating the process group to enable/disable services for- Returns:
- the activate response
- Throws:
NiFiClientExceptionIOException
-
getClusterSummary
- Returns:
- cluster summary response
- Throws:
NiFiClientExceptionIOException
-
getControllerServices
Retrieves the controller services for the reporting tasks.- Returns:
- the controller services entity
- Throws:
NiFiClientExceptionIOException
-
getReportingTasks
Retrieves the reporting tasks.- Returns:
- the reporting tasks entity
- Throws:
NiFiClientExceptionIOException
-
getReportingTaskSnapshot
org.apache.nifi.flow.VersionedReportingTaskSnapshot getReportingTaskSnapshot() throws NiFiClientException, IOExceptionRetrieves the snapshot of all reporting tasks and their respective controller services.- Returns:
- the snapshot
- Throws:
NiFiClientExceptionIOException
-
getReportingTaskSnapshot
org.apache.nifi.flow.VersionedReportingTaskSnapshot getReportingTaskSnapshot(String reportingTaskId) throws NiFiClientException, IOException Retrieves the snapshot of the given reporting task and it's respective controller services.- Returns:
- the snapshot
- Throws:
NiFiClientExceptionIOException
-
getParamProviders
Retrieves the parameter providers.- Returns:
- the parameter providers entity
- Throws:
NiFiClientExceptionIOException
-
getConnectionStatus
ConnectionStatusEntity getConnectionStatus(String connectionId, boolean nodewise) throws NiFiClientException, IOException Retrieves the status for the connection with the given ID- Parameters:
connectionId- the id of the connectionnodewise- whether or not node-wise information should be returned- Returns:
- the status for the connection
- Throws:
NiFiClientExceptionIOException
-
getProcessGroupStatus
ProcessGroupStatusEntity getProcessGroupStatus(String groupId, boolean recursive) throws NiFiClientException, IOException Retrieves the status for the process group with the given ID- Parameters:
groupId- the id of the process grouprecursive- whether or not to recurse into sub groups- Returns:
- the status for the process group
- Throws:
NiFiClientExceptionIOException
-
getProcessorTypes
Retrieves the available processor types.- Returns:
- the processor types
- Throws:
NiFiClientExceptionIOException
-
getControllerServiceTypes
Retrieves the available controller service types.- Returns:
- the controller service types
- Throws:
NiFiClientExceptionIOException
-
getReportingTaskTypes
Retrieves the available reporting task types.- Returns:
- the reporting task types
- Throws:
NiFiClientExceptionIOException
-
getFlowRegistryBranches
FlowRegistryBranchesEntity getFlowRegistryBranches(String registryClientId) throws NiFiClientException, IOException Returns the list of branches for the specified registry client ID- Parameters:
registryClientId- Registry Client ID- Returns:
- list of branches
- Throws:
NiFiClientExceptionIOException
-
getFlowRegistryBuckets
FlowRegistryBucketsEntity getFlowRegistryBuckets(String registryClientId, String branch) throws NiFiClientException, IOException Returns the list of buckets in a given branch for the specified registry client ID- Parameters:
registryClientId- Registry Client IDbranch- Name of the branch- Returns:
- list of buckets
- Throws:
NiFiClientExceptionIOException
-
getFlowRegistryFlows
VersionedFlowsEntity getFlowRegistryFlows(String registryClientId, String branch, String bucket) throws NiFiClientException, IOException Returns the list of flows in a given branch and bucket for the specified registry client ID- Parameters:
registryClientId- Registry Client IDbranch- Name of the branchbucket- ID of the bucket- Returns:
- list of flows
- Throws:
NiFiClientExceptionIOException
-