Skip to main content

Flow

nifi_rust_client::v2_9_0::api::flow

Struct Flow 

Source 
pub struct Flow<'a> { /* private fields */ }

Implementations§

Source§

impl<'a> Flow<'a>

Source

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

Retrieves details about this NiFi to put in the About dialog

Calls GET /nifi-api/flow/about.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/additional-details/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The processor type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The additional details for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

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

Retrieves the banners for this NiFi

Calls GET /nifi-api/flow/banners.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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

Calls GET /nifi-api/flow/bulletin-board.

§Parameters
  • after: Includes bulletins with an id after this value.
  • source_name: Includes bulletins originating from this sources whose name match this regular expression.
  • message: Includes bulletins whose message that match this regular expression.
  • source_id: Includes bulletins originating from this sources whose id match this regular expression.
  • group_id: Includes bulletins originating from this sources whose group id match this regular expression.
  • limit: The number of bulletins to limit the response to. Optional, default is no limit.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /flow
  • Read - /{component-type}/{uuid} - For component specific bulletins
Source

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

Generates a client id.

Calls GET /nifi-api/flow/client-id.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

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.

Calls GET /nifi-api/flow/cluster/search-results.

§Parameters
  • q: Node address to search for.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

The cluster summary for this NiFi

Calls GET /nifi-api/flow/cluster/summary.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Retrieves the configuration for this NiFi flow

Calls GET /nifi-api/flow/config.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_connector_definition( &self, group: &str, artifact: &str, version: &str, type: &str, ) -> Result<ConnectorDefinition, NifiError>

Retrieves the Connector Definition for the specified component type.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/connector-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The connector type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The connector definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub async fn get_connector_types( &self, bundle_group_filter: Option<&str>, bundle_artifact_filter: Option<&str>, type: Option<&str>, ) -> Result<ConnectorTypesEntity, NifiError>

Retrieves the types of connectors that this NiFi supports

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/connector-types.

§Parameters
  • bundle_group_filter: If specified, will only return types that are a member of this bundle group.
  • bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact.
  • type: If specified, will only return types whose fully qualified classname matches.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_connectors(&self) -> Result<ConnectorsEntity, NifiError>

Gets all connectors

Calls GET /nifi-api/flow/connectors.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Retrieves the registered content viewers

Calls GET /nifi-api/flow/content-viewers.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/controller-service-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The controller service type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The controller service definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub 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

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/controller-service-types.

§Parameters
  • service_type: If specified, will only return controller services that are compatible with this type of service.
  • service_bundle_group: If serviceType specified, is the bundle group of the serviceType.
  • service_bundle_artifact: If serviceType specified, is the bundle artifact of the serviceType.
  • service_bundle_version: If serviceType specified, is the bundle version of the serviceType.
  • bundle_group_filter: If specified, will only return types that are a member of this bundle group.
  • bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact.
  • type_filter: If specified, will only return types whose fully qualified classname matches.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Retrieves Controller level bulletins

Calls GET /nifi-api/flow/controller/bulletins.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /flow
  • Read - /controller - For controller bulletins
  • Read - /controller-services/{uuid} - For controller service bulletins
  • Read - /reporting-tasks/{uuid} - For reporting task bulletins
Source

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

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.

Calls GET /nifi-api/flow/controller/controller-services.

§Parameters
  • include_referencing_components: Whether or not to include services’ referencing components in the response
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Retrieves the user identity of the user making the request

Calls GET /nifi-api/flow/current-user.

Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/flow-analysis-rule-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The flow analysis rule type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The flow analysis rule definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub 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

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/flow-analysis-rule-types.

§Parameters
  • bundle_group_filter: If specified, will only return types that are a member of this bundle group.
  • bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact.
  • type: If specified, will only return types whose fully qualified classname matches.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Returns all flow analysis results currently in effect

Calls GET /nifi-api/flow/flow-analysis/results.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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

Calls GET /nifi-api/flow/flow-analysis/results/{processGroupId}.

§Parameters
  • process_group_id: The id of the process group representing (a part of) the flow to be analyzed.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/flow-registry-client-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The flow registry client type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The flow registry client definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub 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

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/history.

§Parameters
  • offset: The offset into the result set.
  • count: The number of actions to return.
  • sort_column: The field to sort on.
  • sort_order: The direction to sort.
  • start_date: Include actions after this date.
  • end_date: Include actions before this date.
  • user_identity: Include actions performed by this user.
  • source_id: Include actions on this component.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Gets configuration history for a component

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/history/components/{componentId}.

§Parameters
  • component_id: The component id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /flow
  • Read underlying component - /{component-type}/{uuid}
Source

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

Gets an action

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/history/{id}.

§Parameters
  • id: The action id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

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

Calls GET /nifi-api/flow/listen-ports.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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<Vec<u8>, NifiError>

Gets all metrics for the flow from a particular node

Calls GET /nifi-api/flow/metrics/{producer}.

§Parameters
  • producer: The producer for flow file metrics. Each producer may have its own output format.
  • included_registries: Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default.
  • sample_name: Regular Expression Pattern to be applied against the sample name field
  • sample_label_value: Regular Expression Pattern to be applied against the sample label value field
  • root_field_name: Name of the first field of JSON object. Applicable for JSON producer only.
  • flow_metrics_reporting_strategy: Flow metrics reporting strategy limits collected metrics
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_flow_metrics_stream( &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<BytesStream, NifiError>

Streaming variant: yields body chunks as they arrive instead of buffering the whole response.

Gets all metrics for the flow from a particular node

Calls GET /nifi-api/flow/metrics/{producer}.

§Parameters
  • producer: The producer for flow file metrics. Each producer may have its own output format.
  • included_registries: Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default.
  • sample_name: Regular Expression Pattern to be applied against the sample name field
  • sample_label_value: Regular Expression Pattern to be applied against the sample label value field
  • root_field_name: Name of the first field of JSON object. Applicable for JSON producer only.
  • flow_metrics_reporting_strategy: Flow metrics reporting strategy limits collected metrics
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Gets all Parameter Contexts

Calls GET /nifi-api/flow/parameter-contexts.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /parameter-contexts/{id} for each Parameter Context.

Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/parameter-provider-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The parameter provider type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The reporting task definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub 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

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/parameter-provider-types.

§Parameters
  • bundle_group_filter: If specified, will only return types that are a member of this bundle group.
  • bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact.
  • type: If specified, will only return types whose fully qualified classname matches.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Gets all parameter providers

Calls GET /nifi-api/flow/parameter-providers.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Retrieves the types of prioritizers that this NiFi supports

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/prioritizers.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

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.

Calls GET /nifi-api/flow/process-groups/{id}.

§Parameters
  • id: The process group id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Schedule or unschedule components in the specified Process Group.

Calls PUT /nifi-api/flow/process-groups/{id}.

§Parameters
  • id: The process group id.
  • body: The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /flow
  • Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every component being scheduled/unscheduled
Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/processor-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The processor type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The processor definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub 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

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/processor-types.

§Parameters
  • bundle_group_filter: If specified, will only return types that are a member of this bundle group.
  • bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact.
  • type: If specified, will only return types whose fully qualified classname matches.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Gets the listing of available flow registry clients

Calls GET /nifi-api/flow/registries.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/reporting-task-definition/{group}/{artifact}/{version}/{type}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • type: The reporting task type
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The reporting task definition for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub 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

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/reporting-task-types.

§Parameters
  • bundle_group_filter: If specified, will only return types that are a member of this bundle group.
  • bundle_artifact_filter: If specified, will only return types that are a member of this bundle artifact.
  • type: If specified, will only return types whose fully qualified classname matches.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Gets all reporting tasks

Calls GET /nifi-api/flow/reporting-tasks.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

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

Calls GET /nifi-api/flow/reporting-tasks/download.

§Parameters
  • reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.
§Errors
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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

Calls GET /nifi-api/flow/reporting-tasks/snapshot.

§Parameters
  • reporting_task_id: Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.
§Errors
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Retrieves the runtime manifest for this NiFi instance.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/runtime-manifest.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub 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

Only search results from authorized components will be returned.

Calls GET /nifi-api/flow/search-results.

§Parameters
  • q: The search term.
  • a: The id of the currently visited process group. If not specified, then the root process group is used.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

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

Gets the current status of this NiFi

Calls GET /nifi-api/flow/status.

§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_step_documentation( &self, group: &str, artifact: &str, version: &str, connector_type: &str, step_name: &str, ) -> Result<StepDocumentationEntity, NifiError>

Retrieves the step documentation for the specified Connector configuration step.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

Calls GET /nifi-api/flow/steps/{group}/{artifact}/{version}/{connectorType}/{stepName}.

§Parameters
  • group: The bundle group
  • artifact: The bundle artifact
  • version: The bundle version
  • connector_type: The fully qualified Connector type
  • step_name: The configuration step name
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The step documentation for the coordinates could not be located.
§Permissions

Requires Read - /flow.

Source

pub async fn get_branches( &self, id: &str, ) -> Result<FlowRegistryBranchesEntity, NifiError>

Gets the branches from the specified registry for the current user

Calls GET /nifi-api/flow/registries/{id}/branches.

§Parameters
  • id: The registry id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_version_differences( &self, registry_id: &str, branch_id_a: &str, bucket_id_a: &str, flow_id_a: &str, version_a: &str, branch_id_b: &str, bucket_id_b: &str, flow_id_b: &str, version_b: &str, offset: Option<i32>, limit: Option<i32>, ) -> Result<FlowComparisonEntity, NifiError>

Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version

Calls GET /nifi-api/flow/registries/{registry-id}/branches/{branch-id-a}/buckets/{bucket-id-a}/flows/{flow-id-a}/{version-a}/diff/branches/{branch-id-b}/buckets/{bucket-id-b}/flows/{flow-id-b}/{version-b}.

§Parameters
  • registry_id: The registry client id.
  • branch_id_a: The branch id for the base version.
  • bucket_id_a: The bucket id for the base version.
  • flow_id_a: The flow id for the base version.
  • version_a: The base version.
  • branch_id_b: The branch id for the compared version.
  • bucket_id_b: The bucket id for the compared version.
  • flow_id_b: The flow id for the compared version.
  • version_b: The compared version.
  • offset: Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.
  • limit: Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_breadcrumbs( &self, id: &str, ) -> Result<FlowBreadcrumbEntity, NifiError>

Gets the breadcrumbs for a process group

Calls GET /nifi-api/flow/process-groups/{id}/breadcrumbs.

§Parameters
  • id: The process group id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_buckets( &self, id: &str, branch: Option<&str>, ) -> Result<FlowRegistryBucketsEntity, NifiError>

Gets the buckets from the specified registry for the current user

Calls GET /nifi-api/flow/registries/{id}/buckets.

§Parameters
  • id: The registry id.
  • branch: The name of a branch to get the buckets from. If not specified the default branch of the registry client will be used.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_flows( &self, registry_id: &str, bucket_id: &str, branch: Option<&str>, ) -> Result<VersionedFlowsEntity, NifiError>

Gets the flows from the specified registry and bucket for the current user

Calls GET /nifi-api/flow/registries/{registry-id}/buckets/{bucket-id}/flows.

§Parameters
  • registry_id: The registry client id.
  • bucket_id: The bucket id.
  • branch: The name of a branch to get the flows from. If not specified the default branch of the registry client will be used.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_details( &self, registry_id: &str, bucket_id: &str, flow_id: &str, branch: Option<&str>, ) -> Result<VersionedFlowDto, NifiError>

Gets the details of a flow from the specified registry and bucket for the specified flow for the current user

Calls GET /nifi-api/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/details.

§Parameters
  • registry_id: The registry client id.
  • bucket_id: The bucket id.
  • flow_id: The flow id.
  • branch: The name of a branch to get the flow from. If not specified the default branch of the registry client will be used.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_versions( &self, registry_id: &str, bucket_id: &str, flow_id: &str, branch: Option<&str>, ) -> Result<VersionedFlowSnapshotMetadataSetEntity, NifiError>

Gets the flow versions from the specified registry and bucket for the specified flow for the current user

Calls GET /nifi-api/flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions.

§Parameters
  • registry_id: The registry client id.
  • bucket_id: The bucket id.
  • flow_id: The flow id.
  • branch: The name of a branch to get the flow versions from. If not specified the default branch of the registry client will be used.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn clear_bulletins( &self, id: &str, body: &ClearBulletinsForGroupRequestEntity, ) -> Result<ClearBulletinsForGroupResultsEntity, NifiError>

Clears bulletins for components in the specified Process Group.

Calls POST /nifi-api/flow/process-groups/{id}/bulletins/clear-requests.

§Parameters
  • id: The process group id.
  • body: The request to clear bulletins. If the components in the request are not specified, all authorized components will be considered.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /flow
  • Write - /process-groups/{uuid} - For the process group
  • Write - /{component-type}/{uuid} - For every component having bulletins cleared
Source

pub async fn get_controller_services_from_group( &self, id: &str, include_ancestor_groups: Option<bool>, include_descendant_groups: Option<bool>, include_referencing_components: Option<bool>, ui_only: Option<bool>, ) -> Result<ControllerServicesEntity, NifiError>

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.

Calls GET /nifi-api/flow/process-groups/{id}/controller-services.

§Parameters
  • id: The process group id.
  • include_ancestor_groups: Whether or not to include parent/ancestor process groups
  • include_descendant_groups: Whether or not to include descendant process groups
  • include_referencing_components: Whether or not to include services’ referencing components in the response
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn activate_controller_services( &self, id: &str, body: &ActivateControllerServicesEntity, ) -> Result<ActivateControllerServicesEntity, NifiError>

Enable or disable Controller Services in the specified Process Group.

Calls PUT /nifi-api/flow/process-groups/{id}/controller-services.

§Parameters
  • id: The process group id.
  • body: The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions
  • Read - /flow
  • Write - /{component-type}/{uuid} or /operation/{component-type}/{uuid} - For every service being enabled/disabled
Source

pub async fn get_connection_statistics( &self, id: &str, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ConnectionStatisticsEntity, NifiError>

Gets statistics for a connection

Calls GET /nifi-api/flow/connections/{id}/statistics.

§Parameters
  • id: The connection id.
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the statistics.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_connection_status( &self, id: &str, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ConnectionStatusEntity, NifiError>

Gets status for a connection

Calls GET /nifi-api/flow/connections/{id}/status.

§Parameters
  • id: The connection id.
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the status.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_connection_status_history( &self, id: &str, ) -> Result<StatusHistoryEntity, NifiError>

Gets the status history for a connection

Calls GET /nifi-api/flow/connections/{id}/status/history.

§Parameters
  • id: The connection id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_input_port_status( &self, id: &str, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<PortStatusEntity, NifiError>

Gets status for an input port

Calls GET /nifi-api/flow/input-ports/{id}/status.

§Parameters
  • id: The input port id.
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the status.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_output_port_status( &self, id: &str, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<PortStatusEntity, NifiError>

Gets status for an output port

Calls GET /nifi-api/flow/output-ports/{id}/status.

§Parameters
  • id: The output port id.
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the status.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_process_group_status( &self, id: &str, recursive: Option<bool>, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ProcessGroupStatusEntity, NifiError>

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.

Calls GET /nifi-api/flow/process-groups/{id}/status.

§Parameters
  • id: The process group id.
  • recursive: Whether all descendant groups and the status of their content will be included. Optional, defaults to false
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the status.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_process_group_status_history( &self, id: &str, ) -> Result<StatusHistoryEntity, NifiError>

Gets status history for a remote process group

Calls GET /nifi-api/flow/process-groups/{id}/status/history.

§Parameters
  • id: The process group id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_processor_status( &self, id: &str, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<ProcessorStatusEntity, NifiError>

Gets status for a processor

Calls GET /nifi-api/flow/processors/{id}/status.

§Parameters
  • id: The processor id.
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the status.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_processor_status_history( &self, id: &str, ) -> Result<StatusHistoryEntity, NifiError>

Gets status history for a processor

Calls GET /nifi-api/flow/processors/{id}/status/history.

§Parameters
  • id: The processor id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_remote_process_group_status( &self, id: &str, nodewise: Option<bool>, cluster_node_id: Option<&str>, ) -> Result<RemoteProcessGroupStatusEntity, NifiError>

Gets status for a remote process group

Calls GET /nifi-api/flow/remote-process-groups/{id}/status.

§Parameters
  • id: The remote process group id.
  • nodewise: Whether or not to include the breakdown per node. Optional, defaults to false
  • cluster_node_id: The id of the node where to get the status.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Source

pub async fn get_remote_process_group_status_history( &self, id: &str, ) -> Result<StatusHistoryEntity, NifiError>

Gets the status history

Calls GET /nifi-api/flow/remote-process-groups/{id}/status/history.

§Parameters
  • id: The remote process group id.
§Errors
  • 400: NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
  • 401: Client could not be authenticated.
  • 403: Client is not authorized to make this request.
  • 404: The specified resource could not be found.
  • 409: The request was valid but NiFi was not in the appropriate state to process it.
§Permissions

Requires Read - /flow.

Auto Trait Implementations§

§

impl<'a> Freeze for Flow<'a>

§

impl<'a> !RefUnwindSafe for Flow<'a>

§

impl<'a> Send for Flow<'a>

§

impl<'a> Sync for Flow<'a>

§

impl<'a> Unpin for Flow<'a>

§

impl<'a> UnsafeUnpin for Flow<'a>

§

impl<'a> !UnwindSafe for Flow<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more