org.apache.nifi.registry.client

Interface FlowClient

All Known Implementing Classes:

JerseyFlowClient

public interface FlowClient

Client for interacting with flows.

Method Summary

Modifier and Type	Method and Description
VersionedFlow	create(VersionedFlow flow) Create the given flow in the given bucket.
VersionedFlow	delete(String bucketId, String flowId) Deletes the flow with the given id in the given bucket.
VersionedFlowDifference	diff(String bucketId, String flowId, Integer versionA, Integer versionB)
VersionedFlow	get(String flowId) Gets the flow with the given id.
VersionedFlow	get(String bucketId, String flowId) Gets the flow with the given id in the given bucket.
List<VersionedFlow>	getByBucket(String bucketId) Gets the flows for a given bucket.
Fields	getFields() Gets the field info for flows.
VersionedFlow	update(String bucketId, VersionedFlow flow) Updates the given flow with in the given bucket.

Method Detail

create

VersionedFlow create(VersionedFlow flow)
              throws NiFiRegistryException,
                     IOException

Create the given flow in the given bucket.

Parameters:

flow - the flow to create

Returns:

the created flow with the identifier populated

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

VersionedFlow get(String bucketId,
                  String flowId)
           throws NiFiRegistryException,
                  IOException

Gets the flow with the given id in the given bucket. The list of snapshot metadata will NOT be populated.

Parameters:

bucketId - a bucket id

flowId - a flow id

Returns:

the flow with the given id in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

VersionedFlow get(String flowId)
           throws NiFiRegistryException,
                  IOException

Gets the flow with the given id.

Parameters:

flowId - a flow id

Returns:

the flow with the given id

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

update

VersionedFlow update(String bucketId,
                     VersionedFlow flow)
              throws NiFiRegistryException,
                     IOException

Updates the given flow with in the given bucket. The identifier of the flow must be populated in the flow object, and only the name and description can be updated.

Parameters:

bucketId - a bucket id

flow - the flow with updates

Returns:

the updated flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

delete

VersionedFlow delete(String bucketId,
                     String flowId)
              throws NiFiRegistryException,
                     IOException

Deletes the flow with the given id in the given bucket.

Parameters:

bucketId - a bucket id

flowId - the id of the flow to delete

Returns:

the deleted flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getFields

Fields getFields()
          throws NiFiRegistryException,
                 IOException

Gets the field info for flows.

Returns:

field info for flows

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getByBucket

List<VersionedFlow> getByBucket(String bucketId)
                         throws NiFiRegistryException,
                                IOException

Gets the flows for a given bucket.

Parameters:

bucketId - a bucket id

Returns:

the flows in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

diff

VersionedFlowDifference diff(String bucketId,
                             String flowId,
                             Integer versionA,
                             Integer versionB)
                      throws NiFiRegistryException,
                             IOException

Parameters:

bucketId - a bucket id

flowId - the flow that is under inspection

versionA - the first version to use in the comparison

versionB - the second flow to use in the comparison

Returns:

the list of differences between the 2 flow versions grouped by component

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered