org.apache.nifi.registry.client

Interface FlowSnapshotClient

All Known Implementing Classes:

JerseyFlowSnapshotClient

public interface FlowSnapshotClient

Client for interacting with snapshots.

Method Summary

Modifier and Type	Method and Description
VersionedFlowSnapshot	create(VersionedFlowSnapshot snapshot) Creates a new snapshot/version for the given flow.
VersionedFlowSnapshot	get(String flowId, int version) Gets the snapshot for the given flow and version.
VersionedFlowSnapshot	get(String bucketId, String flowId, int version) Gets the snapshot for the given bucket, flow, and version.
VersionedFlowSnapshot	getLatest(String flowId) Gets the latest snapshot for the given flow.
VersionedFlowSnapshot	getLatest(String bucketId, String flowId) Gets the latest snapshot for the given flow.
VersionedFlowSnapshotMetadata	getLatestMetadata(String flowId) Gets the latest snapshot metadata for the given flow.
VersionedFlowSnapshotMetadata	getLatestMetadata(String bucketId, String flowId) Gets the latest snapshot metadata for the given flow.
List<VersionedFlowSnapshotMetadata>	getSnapshotMetadata(String flowId) Gets a list of the metadata for all snapshots of a given flow.
List<VersionedFlowSnapshotMetadata>	getSnapshotMetadata(String bucketId, String flowId) Gets a list of the metadata for all snapshots of a given flow.

Method Detail

create

VersionedFlowSnapshot create(VersionedFlowSnapshot snapshot)
                      throws NiFiRegistryException,
                             IOException

Creates a new snapshot/version for the given flow. The snapshot object must have the version populated, and will receive an error if the submitted version is not the next one-up version.

Parameters:

snapshot - the new snapshot

Returns:

the created snapshot

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

VersionedFlowSnapshot get(String bucketId,
                          String flowId,
                          int version)
                   throws NiFiRegistryException,
                          IOException

Gets the snapshot for the given bucket, flow, and version.

Parameters:

bucketId - the bucket id

flowId - the flow id

version - the version

Returns:

the snapshot with the given version of the given flow in the given bucket

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

get

VersionedFlowSnapshot get(String flowId,
                          int version)
                   throws NiFiRegistryException,
                          IOException

Gets the snapshot for the given flow and version.

Parameters:

flowId - the flow id

version - the version

Returns:

the snapshot with the given version of the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatest

VersionedFlowSnapshot getLatest(String bucketId,
                                String flowId)
                         throws NiFiRegistryException,
                                IOException

Gets the latest snapshot for the given flow.

Parameters:

bucketId - the bucket id

flowId - the flow id

Returns:

the snapshot with the latest version for the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatest

VersionedFlowSnapshot getLatest(String flowId)
                         throws NiFiRegistryException,
                                IOException

Gets the latest snapshot for the given flow.

Parameters:

flowId - the flow id

Returns:

the snapshot with the latest version for the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatestMetadata

VersionedFlowSnapshotMetadata getLatestMetadata(String bucketId,
                                                String flowId)
                                         throws NiFiRegistryException,
                                                IOException

Gets the latest snapshot metadata for the given flow.

Parameters:

bucketId - the bucket id

flowId - the flow id

Returns:

the snapshot metadata for the latest version of the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getLatestMetadata

VersionedFlowSnapshotMetadata getLatestMetadata(String flowId)
                                         throws NiFiRegistryException,
                                                IOException

Gets the latest snapshot metadata for the given flow.

Parameters:

flowId - the flow id

Returns:

the snapshot metadata for the latest version of the given flow

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getSnapshotMetadata

List<VersionedFlowSnapshotMetadata> getSnapshotMetadata(String bucketId,
                                                        String flowId)
                                                 throws NiFiRegistryException,
                                                        IOException

Gets a list of the metadata for all snapshots of a given flow. The contents of each snapshot are not part of the response.

Parameters:

bucketId - the bucket id

flowId - the flow id

Returns:

the list of snapshot metadata

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered

getSnapshotMetadata

List<VersionedFlowSnapshotMetadata> getSnapshotMetadata(String flowId)
                                                 throws NiFiRegistryException,
                                                        IOException

Gets a list of the metadata for all snapshots of a given flow. The contents of each snapshot are not part of the response.

Parameters:

flowId - the flow id

Returns:

the list of snapshot metadata

Throws:

NiFiRegistryException - if an error is encountered other than IOException

IOException - if an I/O error is encountered