Enum FlowApiDispatch 

#[non_exhaustive]
pub enum FlowApiDispatch<'a> {
    V2_6_0(V2_6_0FlowApi<'a>),
    V2_7_2(V2_7_2FlowApi<'a>),
    V2_8_0(V2_8_0FlowApi<'a>),
}

Dynamic dispatch enum for the Flow API. Use via the FlowApi trait.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

V2_6_0(V2_6_0FlowApi<'a>)

V2_7_2(V2_7_2FlowApi<'a>)

V2_8_0(V2_8_0FlowApi<'a>)

Trait Implementations

impl FlowApi for FlowApiDispatch<'_>

fn branches<'b>(&'b self, id: &'b str) -> impl FlowBranchesApi + 'b

Returns a sub-resource accessor for config operations.

fn breadcrumbs<'b>(&'b self, id: &'b str) -> impl FlowBreadcrumbsApi + 'b

Returns a sub-resource accessor for config operations.

fn buckets<'b>(&'b self, id: &'b str) -> impl FlowBucketsApi + 'b

Returns a sub-resource accessor for config operations.

fn bulletins<'b>(&'b self, id: &'b str) -> impl FlowBulletinsApi + 'b

Returns a sub-resource accessor for config operations.

fn controller_services<'b>( &'b self, id: &'b str, ) -> impl FlowControllerServicesApi + 'b

Returns a sub-resource accessor for config operations.

fn statistics<'b>(&'b self, id: &'b str) -> impl FlowStatisticsApi + 'b

Returns a sub-resource accessor for config operations.

fn status<'b>(&'b self, id: &'b str) -> impl FlowStatusApi + 'b

Returns a sub-resource accessor for config operations.

async fn download_reporting_task_snapshot( &self, reporting_task_id: Option<&str>, ) -> Result<(), NifiError>

Download a snapshot of the given reporting tasks and any controller services they use

async fn generate_client_id(&self) -> Result<(), NifiError>

Generates a client id.

async fn get_about_info(&self) -> Result<AboutDto, NifiError>

Retrieves details about this NiFi to put in the About dialog

async fn get_action(&self, id: &str) -> Result<ActionEntity, NifiError>

Gets an action

async fn get_additional_details( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<AdditionalDetailsEntity, NifiError>

Retrieves the additional details for the specified component type.

async fn get_all_flow_analysis_results( &self, ) -> Result<FlowAnalysisResultEntity, NifiError>

Returns all flow analysis results currently in effect

async fn get_banners(&self) -> Result<BannerDto, NifiError>

Retrieves the banners for this NiFi

async fn get_bulletin_board( &self, after: Option<&str>, source_name: Option<&str>, message: Option<&str>, source_id: Option<&str>, group_id: Option<&str>, limit: Option<&str>, ) -> Result<BulletinBoardDto, NifiError>

Gets current bulletins

async fn get_bulletins(&self) -> Result<ControllerBulletinsEntity, NifiError>

Retrieves Controller level bulletins

async fn get_cluster_summary(&self) -> Result<ClusterSummaryDto, NifiError>

The cluster summary for this NiFi

async fn get_component_history( &self, component_id: &str, ) -> Result<ComponentHistoryDto, NifiError>

Gets configuration history for a component

async fn get_content_viewers(&self) -> Result<ContentViewerEntity, NifiError>

Retrieves the registered content viewers

async fn get_controller_service_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<ControllerServiceDefinition, NifiError>

Retrieves the Controller Service Definition for the specified component type.

async fn get_controller_service_types( &self, service_type: Option<&str>, service_bundle_group: Option<&str>, service_bundle_artifact: Option<&str>, service_bundle_version: Option<&str>, bundle_group_filter: Option<&str>, bundle_artifact_filter: Option<&str>, type_filter: Option<&str>, ) -> Result<ControllerServiceTypesEntity, NifiError>

Retrieves the types of controller services that this NiFi supports

async fn get_controller_services_from_controller( &self, ui_only: Option<bool>, include_referencing_components: Option<bool>, ) -> Result<ControllerServicesEntity, NifiError>

Gets controller services for reporting tasks

async fn get_controller_status(&self) -> Result<ControllerStatusDto, NifiError>

Gets the current status of this NiFi

async fn get_current_user(&self) -> Result<CurrentUserEntity, NifiError>

Retrieves the user identity of the user making the request

async fn get_flow( &self, id: &str, ui_only: Option<bool>, ) -> Result<ProcessGroupFlowEntity, NifiError>

Gets a process group

async fn get_flow_analysis_results( &self, process_group_id: &str, ) -> Result<FlowAnalysisResultEntity, NifiError>

Returns flow analysis results produced by the analysis of a given process group

async fn get_flow_analysis_rule_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<FlowAnalysisRuleDefinition, NifiError>

Retrieves the Flow Analysis Rule Definition for the specified component type.

async fn get_flow_analysis_rule_types( &self, bundle_group_filter: Option<&str>, bundle_artifact_filter: Option<&str>, type: Option<&str>, ) -> Result<FlowAnalysisRuleTypesEntity, NifiError>

Retrieves the types of available Flow Analysis Rules

async fn get_flow_config(&self) -> Result<FlowConfigurationDto, NifiError>

Retrieves the configuration for this NiFi flow

async fn get_flow_metrics( &self, producer: &str, included_registries: Option<IncludedRegistries>, sample_name: Option<&str>, sample_label_value: Option<&str>, root_field_name: Option<&str>, flow_metrics_reporting_strategy: Option<FlowMetricsReportingStrategy>, ) -> Result<(), NifiError>

Gets all metrics for the flow from a particular node

async fn get_flow_registry_client_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<FlowRegistryClientDefinition, NifiError>

Retrieves the Flow Registry Client Definition for the specified component type.

async fn get_listen_ports(&self) -> Result<ListenPortsEntity, NifiError>

Gets all listen ports configured on this NiFi that the current user has access to

async fn get_parameter_contexts( &self, ) -> Result<ParameterContextsEntity, NifiError>

Gets all Parameter Contexts

async fn get_parameter_provider_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<ParameterProviderDefinition, NifiError>

Retrieves the Parameter Provider Definition for the specified component type.

async fn get_parameter_provider_types( &self, bundle_group_filter: Option<&str>, bundle_artifact_filter: Option<&str>, type: Option<&str>, ) -> Result<ParameterProviderTypesEntity, NifiError>

Retrieves the types of parameter providers that this NiFi supports

async fn get_parameter_providers( &self, ) -> Result<ParameterProvidersEntity, NifiError>

Gets all parameter providers

async fn get_prioritizers(&self) -> Result<PrioritizerTypesEntity, NifiError>

Retrieves the types of prioritizers that this NiFi supports

async fn get_processor_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<ProcessorDefinition, NifiError>

Retrieves the Processor Definition for the specified component type.

async fn get_processor_types( &self, bundle_group_filter: Option<&str>, bundle_artifact_filter: Option<&str>, type: Option<&str>, ) -> Result<ProcessorTypesEntity, NifiError>

Retrieves the types of processors that this NiFi supports

async fn get_registry_clients( &self, ) -> Result<FlowRegistryClientsEntity, NifiError>

Gets the listing of available flow registry clients

async fn get_reporting_task_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<ReportingTaskDefinition, NifiError>

Retrieves the Reporting Task Definition for the specified component type.

async fn get_reporting_task_snapshot( &self, reporting_task_id: Option<&str>, ) -> Result<VersionedReportingTaskSnapshot, NifiError>

Get a snapshot of the given reporting tasks and any controller services they use

async fn get_reporting_task_types( &self, bundle_group_filter: Option<&str>, bundle_artifact_filter: Option<&str>, type: Option<&str>, ) -> Result<ReportingTaskTypesEntity, NifiError>

Retrieves the types of reporting tasks that this NiFi supports

async fn get_reporting_tasks(&self) -> Result<ReportingTasksEntity, NifiError>

Gets all reporting tasks

async fn get_runtime_manifest(&self) -> Result<RuntimeManifest, NifiError>

Retrieves the runtime manifest for this NiFi instance.

async fn query_history( &self, offset: &str, count: &str, sort_column: Option<&str>, sort_order: Option<&str>, start_date: Option<&str>, end_date: Option<&str>, user_identity: Option<&str>, source_id: Option<&str>, ) -> Result<HistoryDto, NifiError>

Gets configuration history

async fn schedule_components( &self, id: &str, body: &ScheduleComponentsEntity, ) -> Result<ScheduleComponentsEntity, NifiError>

Schedule or unschedule components in the specified Process Group.

async fn search_cluster( &self, q: &str, ) -> Result<ClusterSearchResultsEntity, NifiError>

Searches the cluster for a node with the specified address

async fn search_flow( &self, q: Option<&str>, a: Option<&str>, ) -> Result<SearchResultsDto, NifiError>

Performs a search against this NiFi using the specified search term