<no title>

Apache NiFi REST API

REST API definition for Apache NiFi web services

OpenAPI spec version: 2.6.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.flow_api.FlowApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)[source]

activate_controller_services(body, id, **kwargs)[source]

Enable or disable Controller Services in the specified Process Group.. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding activate_controller_services_with_http_info() method instead.

Parameters:

body (ActivateControllerServicesEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)
id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ActivateControllerServicesEntity

activate_controller_services_with_http_info(body, id, **kwargs)[source]

Enable or disable Controller Services in the specified Process Group.. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding activate_controller_services() method instead.

Parameters:

body (ActivateControllerServicesEntity) – The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered. (required)
id (str) – The process group id. (required)

Returns:

(ActivateControllerServicesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

download_reporting_task_snapshot(**kwargs)[source]

Download a snapshot of the given reporting tasks and any controller services they use. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding download_reporting_task_snapshot_with_http_info() method instead.

Parameters:: reporting_task_id (str) – Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.
Returns:: The response data.
Return type:: str

download_reporting_task_snapshot_with_http_info(**kwargs)[source]

Download a snapshot of the given reporting tasks and any controller services they use. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding download_reporting_task_snapshot() method instead.

Parameters:: reporting_task_id (str) – Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.
Returns:: (str, status_code, headers) - Response data with HTTP details.
Return type:: tuple

generate_client_id(**kwargs)[source]

Generates a client id.. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding generate_client_id_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: str

generate_client_id_with_http_info(**kwargs)[source]

Generates a client id.. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding generate_client_id() method instead.

Args:

Returns:: (str, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_about_info(**kwargs)[source]

Retrieves details about this NiFi to put in the About dialog. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_about_info_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: AboutEntity

get_about_info_with_http_info(**kwargs)[source]

Retrieves details about this NiFi to put in the About dialog. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_about_info() method instead.

Args:

Returns:: (AboutEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_action(id, **kwargs)[source]

Gets an action.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_action_with_http_info() method instead.

Parameters:: id (IntegerParameter) – The action id. (required)
Returns:: The response data.
Return type:: ActionEntity

get_action_with_http_info(id, **kwargs)[source]

Gets an action.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_action() method instead.

Parameters:: id (IntegerParameter) – The action id. (required)
Returns:: (ActionEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_additional_details(group, artifact, version, type, **kwargs)[source]

Retrieves the additional details for the specified component type..

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_additional_details_with_http_info() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The processor type (required)

Returns:

The response data.

Return type:

AdditionalDetailsEntity

get_additional_details_with_http_info(group, artifact, version, type, **kwargs)[source]

Retrieves the additional details for the specified component type..

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_additional_details() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The processor type (required)

Returns:

(AdditionalDetailsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_all_flow_analysis_results(**kwargs)[source]

Returns all flow analysis results currently in effect. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_all_flow_analysis_results_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: FlowAnalysisResultEntity

get_all_flow_analysis_results_with_http_info(**kwargs)[source]

Returns all flow analysis results currently in effect. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_all_flow_analysis_results() method instead.

Args:

Returns:: (FlowAnalysisResultEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_banners(**kwargs)[source]

Retrieves the banners for this NiFi. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_banners_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: BannerEntity

get_banners_with_http_info(**kwargs)[source]

Retrieves the banners for this NiFi. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_banners() method instead.

Args:

Returns:: (BannerEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_branches(id, **kwargs)[source]

Gets the branches from the specified registry for the current user. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_branches_with_http_info() method instead.

Parameters:: id (str) – The registry id. (required)
Returns:: The response data.
Return type:: FlowRegistryBranchesEntity

get_branches_with_http_info(id, **kwargs)[source]

Gets the branches from the specified registry for the current user. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_branches() method instead.

Parameters:: id (str) – The registry id. (required)
Returns:: (FlowRegistryBranchesEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_breadcrumbs(id, **kwargs)[source]

Gets the breadcrumbs for a process group. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_breadcrumbs_with_http_info() method instead.

Parameters:: id (str) – The process group id. (required)
Returns:: The response data.
Return type:: FlowBreadcrumbEntity

get_breadcrumbs_with_http_info(id, **kwargs)[source]

Gets the breadcrumbs for a process group. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_breadcrumbs() method instead.

Parameters:: id (str) – The process group id. (required)
Returns:: (FlowBreadcrumbEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_buckets(id, **kwargs)[source]

Gets the buckets from the specified registry for the current user. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_buckets_with_http_info() method instead.

Parameters:

id (str) – The registry id. (required)
branch (str) – The name of a branch to get the buckets from. If not specified the default branch of the registry client will be used.

Returns:

The response data.

Return type:

FlowRegistryBucketsEntity

get_buckets_with_http_info(id, **kwargs)[source]

Gets the buckets from the specified registry for the current user. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_buckets() method instead.

Parameters:

id (str) – The registry id. (required)
branch (str) – The name of a branch to get the buckets from. If not specified the default branch of the registry client will be used.

Returns:

(FlowRegistryBucketsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bulletin_board(**kwargs)[source]

Gets current bulletins. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_bulletin_board_with_http_info() method instead.

Parameters:

after (LongParameter) – Includes bulletins with an id after this value.
source_name (BulletinBoardPatternParameter) – Includes bulletins originating from this sources whose name match this regular expression.
message (BulletinBoardPatternParameter) – Includes bulletins whose message that match this regular expression.
source_id (BulletinBoardPatternParameter) – Includes bulletins originating from this sources whose id match this regular expression.
group_id (BulletinBoardPatternParameter) – Includes bulletins originating from this sources whose group id match this regular expression.
limit (IntegerParameter) – The number of bulletins to limit the response to.

Returns:

The response data.

Return type:

BulletinBoardEntity

get_bulletin_board_with_http_info(**kwargs)[source]

Gets current bulletins. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_bulletin_board() method instead.

Parameters:

after (LongParameter) – Includes bulletins with an id after this value.
source_name (BulletinBoardPatternParameter) – Includes bulletins originating from this sources whose name match this regular expression.
message (BulletinBoardPatternParameter) – Includes bulletins whose message that match this regular expression.
source_id (BulletinBoardPatternParameter) – Includes bulletins originating from this sources whose id match this regular expression.
group_id (BulletinBoardPatternParameter) – Includes bulletins originating from this sources whose group id match this regular expression.
limit (IntegerParameter) – The number of bulletins to limit the response to.

Returns:

(BulletinBoardEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_bulletins(**kwargs)[source]

Retrieves Controller level bulletins. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_bulletins_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ControllerBulletinsEntity

get_bulletins_with_http_info(**kwargs)[source]

Retrieves Controller level bulletins. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_bulletins() method instead.

Args:

Returns:: (ControllerBulletinsEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_cluster_summary(**kwargs)[source]

The cluster summary for this NiFi. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_cluster_summary_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ClusterSummaryEntity

get_cluster_summary_with_http_info(**kwargs)[source]

The cluster summary for this NiFi. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_cluster_summary() method instead.

Args:

Returns:: (ClusterSummaryEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_component_history(component_id, **kwargs)[source]

Gets configuration history for a component.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_component_history_with_http_info() method instead.

Parameters:: component_id (str) – The component id. (required)
Returns:: The response data.
Return type:: ComponentHistoryEntity

get_component_history_with_http_info(component_id, **kwargs)[source]

Gets configuration history for a component.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_component_history() method instead.

Parameters:: component_id (str) – The component id. (required)
Returns:: (ComponentHistoryEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_connection_statistics(id, **kwargs)[source]

Gets statistics for a connection. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_connection_statistics_with_http_info() method instead.

Parameters:

id (str) – The connection id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the statistics.

Returns:

The response data.

Return type:

ConnectionStatisticsEntity

get_connection_statistics_with_http_info(id, **kwargs)[source]

Gets statistics for a connection. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_connection_statistics() method instead.

Parameters:

id (str) – The connection id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the statistics.

Returns:

(ConnectionStatisticsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_connection_status(id, **kwargs)[source]

Gets status for a connection. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_connection_status_with_http_info() method instead.

Parameters:

id (str) – The connection id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

ConnectionStatusEntity

get_connection_status_history(id, **kwargs)[source]

Gets the status history for a connection. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_connection_status_history_with_http_info() method instead.

Parameters:: id (str) – The connection id. (required)
Returns:: The response data.
Return type:: StatusHistoryEntity

get_connection_status_history_with_http_info(id, **kwargs)[source]

Gets the status history for a connection. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_connection_status_history() method instead.

Parameters:: id (str) – The connection id. (required)
Returns:: (StatusHistoryEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_connection_status_with_http_info(id, **kwargs)[source]

Gets status for a connection. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_connection_status() method instead.

Parameters:

id (str) – The connection id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

(ConnectionStatusEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_content_viewers(**kwargs)[source]

Retrieves the registered content viewers. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_content_viewers_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ContentViewerEntity

get_content_viewers_with_http_info(**kwargs)[source]

Retrieves the registered content viewers. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_content_viewers() method instead.

Args:

Returns:: (ContentViewerEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_controller_service_definition(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_controller_service_definition_with_http_info() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The controller service type (required)

Returns:

The response data.

Return type:

ControllerServiceDefinition

get_controller_service_definition_with_http_info(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_controller_service_definition() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The controller service type (required)

Returns:

(ControllerServiceDefinition, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_controller_service_types(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_controller_service_types_with_http_info() method instead.

Parameters:

service_type (str) – If specified, will only return controller services that are compatible with this type of service.
service_bundle_group (str) – If serviceType specified, is the bundle group of the serviceType.
service_bundle_artifact (str) – If serviceType specified, is the bundle artifact of the serviceType.
service_bundle_version (str) – If serviceType specified, is the bundle version of the serviceType.
bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type_filter (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

The response data.

Return type:

ControllerServiceTypesEntity

get_controller_service_types_with_http_info(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_controller_service_types() method instead.

Parameters:

service_type (str) – If specified, will only return controller services that are compatible with this type of service.
service_bundle_group (str) – If serviceType specified, is the bundle group of the serviceType.
service_bundle_artifact (str) – If serviceType specified, is the bundle artifact of the serviceType.
service_bundle_version (str) – If serviceType specified, is the bundle version of the serviceType.
bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type_filter (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

(ControllerServiceTypesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_controller_services_from_controller(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_controller_services_from_controller_with_http_info() method instead.

Parameters:

ui_only (bool)
include_referencing_components (bool) – Whether or not to include services’ referencing components in the response

Returns:

The response data.

Return type:

ControllerServicesEntity

get_controller_services_from_controller_with_http_info(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_controller_services_from_controller() method instead.

Parameters:

ui_only (bool)
include_referencing_components (bool) – Whether or not to include services’ referencing components in the response

Returns:

(ControllerServicesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_controller_services_from_group(id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_controller_services_from_group_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)
include_ancestor_groups (bool) – Whether or not to include parent/ancestor process groups
include_descendant_groups (bool) – Whether or not to include descendant process groups
include_referencing_components (bool) – Whether or not to include services’ referencing components in the response
ui_only (bool)

Returns:

The response data.

Return type:

ControllerServicesEntity

get_controller_services_from_group_with_http_info(id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_controller_services_from_group() method instead.

Parameters:

id (str) – The process group id. (required)
include_ancestor_groups (bool) – Whether or not to include parent/ancestor process groups
include_descendant_groups (bool) – Whether or not to include descendant process groups
include_referencing_components (bool) – Whether or not to include services’ referencing components in the response
ui_only (bool)

Returns:

(ControllerServicesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_controller_status(**kwargs)[source]

Gets the current status of this NiFi. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_controller_status_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ControllerStatusEntity

get_controller_status_with_http_info(**kwargs)[source]

Gets the current status of this NiFi. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_controller_status() method instead.

Args:

Returns:: (ControllerStatusEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_current_user(**kwargs)[source]

Retrieves the user identity of the user making the request. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_current_user_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: CurrentUserEntity

get_current_user_with_http_info(**kwargs)[source]

Retrieves the user identity of the user making the request. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_current_user() method instead.

Args:

Returns:: (CurrentUserEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_details(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the details of a flow from the specified registry and bucket for the specified flow for the current user. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_details_with_http_info() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
bucket_id (str) – The bucket id. (required)
flow_id (str) – The flow id. (required)
branch (str) – The name of a branch to get the flow from. If not specified the default branch of the registry client will be used.

Returns:

The response data.

Return type:

VersionedFlowEntity

get_details_with_http_info(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the details of a flow from the specified registry and bucket for the specified flow for the current user. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_details() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
bucket_id (str) – The bucket id. (required)
flow_id (str) – The flow id. (required)
branch (str) – The name of a branch to get the flow from. If not specified the default branch of the registry client will be used.

Returns:

(VersionedFlowEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_flow(id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flow_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)
ui_only (bool)

Returns:

The response data.

Return type:

ProcessGroupFlowEntity

get_flow_analysis_results(process_group_id, **kwargs)[source]

Returns flow analysis results produced by the analysis of a given process group. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flow_analysis_results_with_http_info() method instead.

Parameters:: process_group_id (str) – The id of the process group representing (a part of) the flow to be analyzed. (required)
Returns:: The response data.
Return type:: FlowAnalysisResultEntity

get_flow_analysis_results_with_http_info(process_group_id, **kwargs)[source]

Returns flow analysis results produced by the analysis of a given process group. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flow_analysis_results() method instead.

Parameters:: process_group_id (str) – The id of the process group representing (a part of) the flow to be analyzed. (required)
Returns:: (FlowAnalysisResultEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_flow_analysis_rule_definition(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flow_analysis_rule_definition_with_http_info() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The flow analysis rule type (required)

Returns:

The response data.

Return type:

FlowAnalysisRuleDefinition

get_flow_analysis_rule_definition_with_http_info(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flow_analysis_rule_definition() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The flow analysis rule type (required)

Returns:

(FlowAnalysisRuleDefinition, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_flow_analysis_rule_types(**kwargs)[source]

Retrieves the types of available Flow Analysis Rules.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flow_analysis_rule_types_with_http_info() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

The response data.

Return type:

FlowAnalysisRuleTypesEntity

get_flow_analysis_rule_types_with_http_info(**kwargs)[source]

Retrieves the types of available Flow Analysis Rules.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flow_analysis_rule_types() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

(FlowAnalysisRuleTypesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_flow_config(**kwargs)[source]

Retrieves the configuration for this NiFi flow. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flow_config_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: FlowConfigurationEntity

get_flow_config_with_http_info(**kwargs)[source]

Retrieves the configuration for this NiFi flow. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flow_config() method instead.

Args:

Returns:: (FlowConfigurationEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_flow_metrics(producer, **kwargs)[source]

Gets all metrics for the flow from a particular node. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flow_metrics_with_http_info() method instead.

Parameters:

producer (str) – The producer for flow file metrics. Each producer may have its own output format. (required)
included_registries (str) – Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default.
sample_name (str) – Regular Expression Pattern to be applied against the sample name field
sample_label_value (str) – Regular Expression Pattern to be applied against the sample label value field
root_field_name (str) – Name of the first field of JSON object. Applicable for JSON producer only.

Returns:

The response data.

Return type:

StreamingOutput

get_flow_metrics_with_http_info(producer, **kwargs)[source]

Gets all metrics for the flow from a particular node. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flow_metrics() method instead.

Parameters:

producer (str) – The producer for flow file metrics. Each producer may have its own output format. (required)
included_registries (str) – Set of included metrics registries. Duplicate the parameter to include multiple registries. All registries are included by default.
sample_name (str) – Regular Expression Pattern to be applied against the sample name field
sample_label_value (str) – Regular Expression Pattern to be applied against the sample label value field
root_field_name (str) – Name of the first field of JSON object. Applicable for JSON producer only.

Returns:

(StreamingOutput, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_flow_with_http_info(id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flow() method instead.

Parameters:

id (str) – The process group id. (required)
ui_only (bool)

Returns:

(ProcessGroupFlowEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_flows(registry_id, bucket_id, **kwargs)[source]

Gets the flows from the specified registry and bucket for the current user. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_flows_with_http_info() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
bucket_id (str) – The bucket id. (required)
branch (str) – The name of a branch to get the flows from. If not specified the default branch of the registry client will be used.

Returns:

The response data.

Return type:

VersionedFlowsEntity

get_flows_with_http_info(registry_id, bucket_id, **kwargs)[source]

Gets the flows from the specified registry and bucket for the current user. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_flows() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
bucket_id (str) – The bucket id. (required)
branch (str) – The name of a branch to get the flows from. If not specified the default branch of the registry client will be used.

Returns:

(VersionedFlowsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_input_port_status(id, **kwargs)[source]

Gets status for an input port. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_input_port_status_with_http_info() method instead.

Parameters:

id (str) – The input port id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

PortStatusEntity

get_input_port_status_with_http_info(id, **kwargs)[source]

Gets status for an input port. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_input_port_status() method instead.

Parameters:

id (str) – The input port id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

(PortStatusEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_output_port_status(id, **kwargs)[source]

Gets status for an output port. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_output_port_status_with_http_info() method instead.

Parameters:

id (str) – The output port id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

PortStatusEntity

get_output_port_status_with_http_info(id, **kwargs)[source]

Gets status for an output port. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_output_port_status() method instead.

Parameters:

id (str) – The output port id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

(PortStatusEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_parameter_contexts(**kwargs)[source]

Gets all Parameter Contexts. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_parameter_contexts_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ParameterContextsEntity

get_parameter_contexts_with_http_info(**kwargs)[source]

Gets all Parameter Contexts. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_parameter_contexts() method instead.

Args:

Returns:: (ParameterContextsEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_parameter_provider_definition(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_parameter_provider_definition_with_http_info() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The parameter provider type (required)

Returns:

The response data.

Return type:

ParameterProviderDefinition

get_parameter_provider_definition_with_http_info(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_parameter_provider_definition() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The parameter provider type (required)

Returns:

(ParameterProviderDefinition, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_parameter_provider_types(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_parameter_provider_types_with_http_info() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

The response data.

Return type:

ParameterProviderTypesEntity

get_parameter_provider_types_with_http_info(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_parameter_provider_types() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

(ParameterProviderTypesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_parameter_providers(**kwargs)[source]

Gets all parameter providers. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_parameter_providers_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ParameterProvidersEntity

get_parameter_providers_with_http_info(**kwargs)[source]

Gets all parameter providers. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_parameter_providers() method instead.

Args:

Returns:: (ParameterProvidersEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_prioritizers(**kwargs)[source]

Retrieves the types of prioritizers that this NiFi supports.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_prioritizers_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: PrioritizerTypesEntity

get_prioritizers_with_http_info(**kwargs)[source]

Retrieves the types of prioritizers that this NiFi supports.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_prioritizers() method instead.

Args:

Returns:: (PrioritizerTypesEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_process_group_status(id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_process_group_status_with_http_info() method instead.

Parameters:

id (str) – The process group id. (required)
recursive (bool) – Whether all descendant groups and the status of their content will be included. Optional, defaults to false
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

ProcessGroupStatusEntity

get_process_group_status_history(id, **kwargs)[source]

Gets status history for a remote process group. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_process_group_status_history_with_http_info() method instead.

Parameters:: id (str) – The process group id. (required)
Returns:: The response data.
Return type:: StatusHistoryEntity

get_process_group_status_history_with_http_info(id, **kwargs)[source]

Gets status history for a remote process group. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_process_group_status_history() method instead.

Parameters:: id (str) – The process group id. (required)
Returns:: (StatusHistoryEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_process_group_status_with_http_info(id, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_process_group_status() method instead.

Parameters:

id (str) – The process group id. (required)
recursive (bool) – Whether all descendant groups and the status of their content will be included. Optional, defaults to false
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

(ProcessGroupStatusEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_processor_definition(group, artifact, version, type, **kwargs)[source]

Retrieves the Processor Definition for the specified component type..

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_definition_with_http_info() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The processor type (required)

Returns:

The response data.

Return type:

ProcessorDefinition

get_processor_definition_with_http_info(group, artifact, version, type, **kwargs)[source]

Retrieves the Processor Definition for the specified component type..

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor_definition() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The processor type (required)

Returns:

(ProcessorDefinition, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_processor_status(id, **kwargs)[source]

Gets status for a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_status_with_http_info() method instead.

Parameters:

id (str) – The processor id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

ProcessorStatusEntity

get_processor_status_history(id, **kwargs)[source]

Gets status history for a processor. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_status_history_with_http_info() method instead.

Parameters:: id (str) – The processor id. (required)
Returns:: The response data.
Return type:: StatusHistoryEntity

get_processor_status_history_with_http_info(id, **kwargs)[source]

Gets status history for a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor_status_history() method instead.

Parameters:: id (str) – The processor id. (required)
Returns:: (StatusHistoryEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_processor_status_with_http_info(id, **kwargs)[source]

Gets status for a processor. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor_status() method instead.

Parameters:

id (str) – The processor id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

(ProcessorStatusEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_processor_types(**kwargs)[source]

Retrieves the types of processors that this NiFi supports.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_processor_types_with_http_info() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

The response data.

Return type:

ProcessorTypesEntity

get_processor_types_with_http_info(**kwargs)[source]

Retrieves the types of processors that this NiFi supports.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_processor_types() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

(ProcessorTypesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_registry_clients(**kwargs)[source]

Gets the listing of available flow registry clients. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_registry_clients_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: FlowRegistryClientsEntity

get_registry_clients_with_http_info(**kwargs)[source]

Gets the listing of available flow registry clients. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_registry_clients() method instead.

Args:

Returns:: (FlowRegistryClientsEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_remote_process_group_status(id, **kwargs)[source]

Gets status for a remote process group. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_remote_process_group_status_with_http_info() method instead.

Parameters:

id (str) – The remote process group id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

RemoteProcessGroupStatusEntity

get_remote_process_group_status_history(id, **kwargs)[source]

Gets the status history. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_remote_process_group_status_history_with_http_info() method instead.

Parameters:: id (str) – The remote process group id. (required)
Returns:: The response data.
Return type:: StatusHistoryEntity

get_remote_process_group_status_history_with_http_info(id, **kwargs)[source]

Gets the status history. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_remote_process_group_status_history() method instead.

Parameters:: id (str) – The remote process group id. (required)
Returns:: (StatusHistoryEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_remote_process_group_status_with_http_info(id, **kwargs)[source]

Gets status for a remote process group. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_remote_process_group_status() method instead.

Parameters:

id (str) – The remote process group id. (required)
nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false
cluster_node_id (str) – The id of the node where to get the status.

Returns:

(RemoteProcessGroupStatusEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_reporting_task_definition(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_reporting_task_definition_with_http_info() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The reporting task type (required)

Returns:

The response data.

Return type:

ReportingTaskDefinition

get_reporting_task_definition_with_http_info(group, artifact, version, type, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_reporting_task_definition() method instead.

Parameters:

group (str) – The bundle group (required)
artifact (str) – The bundle artifact (required)
version (str) – The bundle version (required)
type (str) – The reporting task type (required)

Returns:

(ReportingTaskDefinition, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_reporting_task_snapshot(**kwargs)[source]

Get a snapshot of the given reporting tasks and any controller services they use. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_reporting_task_snapshot_with_http_info() method instead.

Parameters:: reporting_task_id (str) – Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.
Returns:: The response data.
Return type:: VersionedReportingTaskSnapshot

get_reporting_task_snapshot_with_http_info(**kwargs)[source]

Get a snapshot of the given reporting tasks and any controller services they use. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_reporting_task_snapshot() method instead.

Parameters:: reporting_task_id (str) – Specifies a reporting task id to export. If not specified, all reporting tasks will be exported.
Returns:: (VersionedReportingTaskSnapshot, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_reporting_task_types(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_reporting_task_types_with_http_info() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

The response data.

Return type:

ReportingTaskTypesEntity

get_reporting_task_types_with_http_info(**kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_reporting_task_types() method instead.

Parameters:

bundle_group_filter (str) – If specified, will only return types that are a member of this bundle group.
bundle_artifact_filter (str) – If specified, will only return types that are a member of this bundle artifact.
type (str) – If specified, will only return types whose fully qualified classname matches.

Returns:

(ReportingTaskTypesEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_reporting_tasks(**kwargs)[source]

Gets all reporting tasks. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_reporting_tasks_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: ReportingTasksEntity

get_reporting_tasks_with_http_info(**kwargs)[source]

Gets all reporting tasks. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_reporting_tasks() method instead.

Args:

Returns:: (ReportingTasksEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_runtime_manifest(**kwargs)[source]

Retrieves the runtime manifest for this NiFi instance..

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_runtime_manifest_with_http_info() method instead.

Args:

Returns:: The response data.
Return type:: RuntimeManifestEntity

get_runtime_manifest_with_http_info(**kwargs)[source]

Retrieves the runtime manifest for this NiFi instance..

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_runtime_manifest() method instead.

Args:

Returns:: (RuntimeManifestEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

get_version_differences(registry_id, branch_id_a, bucket_id_a, flow_id_a, version_a, branch_id_b, bucket_id_b, flow_id_b, version_b, **kwargs)[source]

Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_version_differences_with_http_info() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
branch_id_a (str) – The branch id for the base version. (required)
bucket_id_a (str) – The bucket id for the base version. (required)
flow_id_a (str) – The flow id for the base version. (required)
version_a (str) – The base version. (required)
branch_id_b (str) – The branch id for the compared version. (required)
bucket_id_b (str) – The bucket id for the compared version. (required)
flow_id_b (str) – The flow id for the compared version. (required)
version_b (str) – The compared version. (required)
offset (int) – Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.
limit (int) – Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.

Returns:

The response data.

Return type:

FlowComparisonEntity

get_version_differences_with_http_info(registry_id, branch_id_a, bucket_id_a, flow_id_a, version_a, branch_id_b, bucket_id_b, flow_id_b, version_b, **kwargs)[source]

Gets the differences between two versions of the same versioned flow, the basis of the comparison will be the first version. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_version_differences() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
branch_id_a (str) – The branch id for the base version. (required)
bucket_id_a (str) – The bucket id for the base version. (required)
flow_id_a (str) – The flow id for the base version. (required)
version_a (str) – The base version. (required)
branch_id_b (str) – The branch id for the compared version. (required)
bucket_id_b (str) – The bucket id for the compared version. (required)
flow_id_b (str) – The flow id for the compared version. (required)
version_b (str) – The compared version. (required)
offset (int) – Must be a non-negative number. Specifies the starting point of the listing. 0 means start from the beginning.
limit (int) – Limits the number of differences listed. This might lead to partial result. 0 means no limitation is applied.

Returns:

(FlowComparisonEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_versions(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the flow versions from the specified registry and bucket for the specified flow for the current user. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_versions_with_http_info() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
bucket_id (str) – The bucket id. (required)
flow_id (str) – The flow id. (required)
branch (str) – The name of a branch to get the flow versions from. If not specified the default branch of the registry client will be used.

Returns:

The response data.

Return type:

VersionedFlowSnapshotMetadataSetEntity

get_versions_with_http_info(registry_id, bucket_id, flow_id, **kwargs)[source]

Gets the flow versions from the specified registry and bucket for the specified flow for the current user. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_versions() method instead.

Parameters:

registry_id (str) – The registry client id. (required)
bucket_id (str) – The bucket id. (required)
flow_id (str) – The flow id. (required)
branch (str) – The name of a branch to get the flow versions from. If not specified the default branch of the registry client will be used.

Returns:

(VersionedFlowSnapshotMetadataSetEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

query_history(offset, count, **kwargs)[source]

Gets configuration history.

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

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding query_history_with_http_info() method instead.

Parameters:

offset (IntegerParameter) – The offset into the result set. (required)
count (IntegerParameter) – The number of actions to return. (required)
sort_column (str) – The field to sort on.
sort_order (str) – The direction to sort.
start_date (DateTimeParameter) – Include actions after this date.
end_date (DateTimeParameter) – Include actions before this date.
user_identity (str) – Include actions performed by this user.
source_id (str) – Include actions on this component.

Returns:

The response data.

Return type:

HistoryEntity

query_history_with_http_info(offset, count, **kwargs)[source]

Gets configuration history.

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

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding query_history() method instead.

Parameters:

offset (IntegerParameter) – The offset into the result set. (required)
count (IntegerParameter) – The number of actions to return. (required)
sort_column (str) – The field to sort on.
sort_order (str) – The direction to sort.
start_date (DateTimeParameter) – Include actions after this date.
end_date (DateTimeParameter) – Include actions before this date.
user_identity (str) – Include actions performed by this user.
source_id (str) – Include actions on this component.

Returns:

(HistoryEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

schedule_components(body, id, **kwargs)[source]

Schedule or unschedule components in the specified Process Group.. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding schedule_components_with_http_info() method instead.

Parameters:

body (ScheduleComponentsEntity) – The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered. (required)
id (str) – The process group id. (required)

Returns:

The response data.

Return type:

ScheduleComponentsEntity

schedule_components_with_http_info(body, id, **kwargs)[source]

Schedule or unschedule components in the specified Process Group.. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding schedule_components() method instead.

Parameters:

body (ScheduleComponentsEntity) – The request to schedule or unschedule. If the components in the request are not specified, all authorized components will be considered. (required)
id (str) – The process group id. (required)

Returns:

(ScheduleComponentsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

search_cluster(q, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding search_cluster_with_http_info() method instead.

Parameters:: q (str) – Node address to search for. (required)
Returns:: The response data.
Return type:: ClusterSearchResultsEntity

search_cluster_with_http_info(q, **kwargs)[source]

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.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding search_cluster() method instead.

Parameters:: q (str) – Node address to search for. (required)
Returns:: (ClusterSearchResultsEntity, status_code, headers) - Response data with HTTP details.
Return type:: tuple

search_flow(**kwargs)[source]

Performs a search against this NiFi using the specified search term.

Only search results from authorized components will be returned.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding search_flow_with_http_info() method instead.

Parameters:

q (str)
a (str)

Returns:

The response data.

Return type:

SearchResultsEntity

search_flow_with_http_info(**kwargs)[source]

Performs a search against this NiFi using the specified search term.

Only search results from authorized components will be returned.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding search_flow() method instead.

Parameters:

q (str)
a (str)

Returns:

(SearchResultsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple