nipyapi.nifi.models package

Submodules

nipyapi.nifi.models.about_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.about_dto.AboutDTO(title=None, version=None, uri=None, content_viewer_url=None, timezone=None, build_tag=None, build_revision=None, build_branch=None, build_timestamp=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AboutDTO - a model defined in Swagger

attribute_map = {'build_branch': 'buildBranch', 'build_revision': 'buildRevision', 'build_tag': 'buildTag', 'build_timestamp': 'buildTimestamp', 'content_viewer_url': 'contentViewerUrl', 'timezone': 'timezone', 'title': 'title', 'uri': 'uri', 'version': 'version'}

build_branch

Gets the build_branch of this AboutDTO. Build branch

Returns:The build_branch of this AboutDTO. Return type:str

build_revision

Gets the build_revision of this AboutDTO. Build revision or commit hash

Returns:The build_revision of this AboutDTO. Return type:str

build_tag

Gets the build_tag of this AboutDTO. Build tag

Returns:The build_tag of this AboutDTO. Return type:str

build_timestamp

Gets the build_timestamp of this AboutDTO. Build timestamp

Returns:The build_timestamp of this AboutDTO. Return type:str

content_viewer_url

Gets the content_viewer_url of this AboutDTO. The URL for the content viewer if configured.

Returns:The content_viewer_url of this AboutDTO. Return type:str

swagger_types = {'build_branch': 'str', 'build_revision': 'str', 'build_tag': 'str', 'build_timestamp': 'str', 'content_viewer_url': 'str', 'timezone': 'str', 'title': 'str', 'uri': 'str', 'version': 'str'}

timezone

Gets the timezone of this AboutDTO. The timezone of the NiFi instance.

Returns:The timezone of this AboutDTO. Return type:str

title

Gets the title of this AboutDTO. The title to be used on the page and in the about dialog.

Returns:The title of this AboutDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AboutDTO. The URI for the NiFi.

Returns:The uri of this AboutDTO. Return type:str

version

Gets the version of this AboutDTO. The version of this NiFi.

Returns:The version of this AboutDTO. Return type:str

nipyapi.nifi.models.about_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.about_entity.AboutEntity(about=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AboutEntity - a model defined in Swagger

about

Gets the about of this AboutEntity.

Returns:The about of this AboutEntity. Return type:AboutDTO

attribute_map = {'about': 'about'}

swagger_types = {'about': 'AboutDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_configuration_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_configuration_dto.AccessConfigurationDTO(supports_login=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessConfigurationDTO - a model defined in Swagger

attribute_map = {'supports_login': 'supportsLogin'}

supports_login

Gets the supports_login of this AccessConfigurationDTO. Indicates whether or not this NiFi supports user login.

Returns:The supports_login of this AccessConfigurationDTO. Return type:bool

swagger_types = {'supports_login': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_configuration_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_configuration_entity.AccessConfigurationEntity(config=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessConfigurationEntity - a model defined in Swagger

attribute_map = {'config': 'config'}

config

Gets the config of this AccessConfigurationEntity.

Returns:The config of this AccessConfigurationEntity. Return type:AccessConfigurationDTO

swagger_types = {'config': 'AccessConfigurationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_policy_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_policy_dto.AccessPolicyDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, resource=None, action=None, component_reference=None, configurable=None, users=None, user_groups=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicyDTO - a model defined in Swagger

action

Gets the action of this AccessPolicyDTO. The action associated with this access policy.

Returns:The action of this AccessPolicyDTO. Return type:str

attribute_map = {'action': 'action', 'component_reference': 'componentReference', 'configurable': 'configurable', 'id': 'id', 'parent_group_id': 'parentGroupId', 'position': 'position', 'resource': 'resource', 'user_groups': 'userGroups', 'users': 'users', 'versioned_component_id': 'versionedComponentId'}

component_reference

Gets the component_reference of this AccessPolicyDTO. Component this policy references if applicable.

Returns:The component_reference of this AccessPolicyDTO. Return type:ComponentReferenceEntity

configurable

Gets the configurable of this AccessPolicyDTO. Whether this policy is configurable.

Returns:The configurable of this AccessPolicyDTO. Return type:bool

id

Gets the id of this AccessPolicyDTO. The id of the component.

Returns:The id of this AccessPolicyDTO. Return type:str

parent_group_id

Gets the parent_group_id of this AccessPolicyDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this AccessPolicyDTO. Return type:str

position

Gets the position of this AccessPolicyDTO. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicyDTO. Return type:PositionDTO

resource

Gets the resource of this AccessPolicyDTO. The resource for this access policy.

Returns:The resource of this AccessPolicyDTO. Return type:str

swagger_types = {'action': 'str', 'component_reference': 'ComponentReferenceEntity', 'configurable': 'bool', 'id': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'resource': 'str', 'user_groups': 'list[TenantEntity]', 'users': 'list[TenantEntity]', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this AccessPolicyDTO. The set of user group IDs associated with this access policy.

Returns:The user_groups of this AccessPolicyDTO. Return type:list[TenantEntity]

users

Gets the users of this AccessPolicyDTO. The set of user IDs associated with this access policy.

Returns:The users of this AccessPolicyDTO. Return type:list[TenantEntity]

versioned_component_id

Gets the versioned_component_id of this AccessPolicyDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this AccessPolicyDTO. Return type:str

nipyapi.nifi.models.access_policy_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_policy_entity.AccessPolicyEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, generated=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicyEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'generated': 'generated', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this AccessPolicyEntity. The bulletins for this component.

Returns:The bulletins of this AccessPolicyEntity. Return type:list[BulletinEntity]

component

Gets the component of this AccessPolicyEntity.

Returns:The component of this AccessPolicyEntity. Return type:AccessPolicyDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this AccessPolicyEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this AccessPolicyEntity. Return type:bool

generated

Gets the generated of this AccessPolicyEntity. When this content was generated.

Returns:The generated of this AccessPolicyEntity. Return type:str

id

Gets the id of this AccessPolicyEntity. The id of the component.

Returns:The id of this AccessPolicyEntity. Return type:str

permissions

Gets the permissions of this AccessPolicyEntity. The permissions for this component.

Returns:The permissions of this AccessPolicyEntity. Return type:PermissionsDTO

position

Gets the position of this AccessPolicyEntity. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicyEntity. Return type:PositionDTO

revision

Gets the revision of this AccessPolicyEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this AccessPolicyEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'AccessPolicyDTO', 'disconnected_node_acknowledged': 'bool', 'generated': 'str', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AccessPolicyEntity. The URI for futures requests to the component.

Returns:The uri of this AccessPolicyEntity. Return type:str

nipyapi.nifi.models.access_policy_summary_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_policy_summary_dto.AccessPolicySummaryDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, resource=None, action=None, component_reference=None, configurable=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicySummaryDTO - a model defined in Swagger

action

Gets the action of this AccessPolicySummaryDTO. The action associated with this access policy.

Returns:The action of this AccessPolicySummaryDTO. Return type:str

attribute_map = {'action': 'action', 'component_reference': 'componentReference', 'configurable': 'configurable', 'id': 'id', 'parent_group_id': 'parentGroupId', 'position': 'position', 'resource': 'resource', 'versioned_component_id': 'versionedComponentId'}

component_reference

Gets the component_reference of this AccessPolicySummaryDTO. Component this policy references if applicable.

Returns:The component_reference of this AccessPolicySummaryDTO. Return type:ComponentReferenceEntity

configurable

Gets the configurable of this AccessPolicySummaryDTO. Whether this policy is configurable.

Returns:The configurable of this AccessPolicySummaryDTO. Return type:bool

id

Gets the id of this AccessPolicySummaryDTO. The id of the component.

Returns:The id of this AccessPolicySummaryDTO. Return type:str

parent_group_id

Gets the parent_group_id of this AccessPolicySummaryDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this AccessPolicySummaryDTO. Return type:str

position

Gets the position of this AccessPolicySummaryDTO. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicySummaryDTO. Return type:PositionDTO

resource

Gets the resource of this AccessPolicySummaryDTO. The resource for this access policy.

Returns:The resource of this AccessPolicySummaryDTO. Return type:str

swagger_types = {'action': 'str', 'component_reference': 'ComponentReferenceEntity', 'configurable': 'bool', 'id': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'resource': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this AccessPolicySummaryDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this AccessPolicySummaryDTO. Return type:str

nipyapi.nifi.models.access_policy_summary_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_policy_summary_entity.AccessPolicySummaryEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessPolicySummaryEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this AccessPolicySummaryEntity. The bulletins for this component.

Returns:The bulletins of this AccessPolicySummaryEntity. Return type:list[BulletinEntity]

component

Gets the component of this AccessPolicySummaryEntity.

Returns:The component of this AccessPolicySummaryEntity. Return type:AccessPolicySummaryDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this AccessPolicySummaryEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this AccessPolicySummaryEntity. Return type:bool

id

Gets the id of this AccessPolicySummaryEntity. The id of the component.

Returns:The id of this AccessPolicySummaryEntity. Return type:str

permissions

Gets the permissions of this AccessPolicySummaryEntity. The permissions for this component.

Returns:The permissions of this AccessPolicySummaryEntity. Return type:PermissionsDTO

position

Gets the position of this AccessPolicySummaryEntity. The position of this component in the UI if applicable.

Returns:The position of this AccessPolicySummaryEntity. Return type:PositionDTO

revision

Gets the revision of this AccessPolicySummaryEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this AccessPolicySummaryEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'AccessPolicySummaryDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AccessPolicySummaryEntity. The URI for futures requests to the component.

Returns:The uri of this AccessPolicySummaryEntity. Return type:str

nipyapi.nifi.models.access_status_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_status_dto.AccessStatusDTO(identity=None, status=None, message=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessStatusDTO - a model defined in Swagger

attribute_map = {'identity': 'identity', 'message': 'message', 'status': 'status'}

identity

Gets the identity of this AccessStatusDTO. The user identity.

Returns:The identity of this AccessStatusDTO. Return type:str

message

Gets the message of this AccessStatusDTO. Additional details about the user access status.

Returns:The message of this AccessStatusDTO. Return type:str

status

Gets the status of this AccessStatusDTO. The user access status.

Returns:The status of this AccessStatusDTO. Return type:str

swagger_types = {'identity': 'str', 'message': 'str', 'status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.access_status_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.access_status_entity.AccessStatusEntity(access_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AccessStatusEntity - a model defined in Swagger

access_status

Gets the access_status of this AccessStatusEntity.

Returns:The access_status of this AccessStatusEntity. Return type:AccessStatusDTO

attribute_map = {'access_status': 'accessStatus'}

swagger_types = {'access_status': 'AccessStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.action_details_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.action_details_dto.ActionDetailsDTO

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActionDetailsDTO - a model defined in Swagger

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.action_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.action_dto.ActionDTO(id=None, user_identity=None, timestamp=None, source_id=None, source_name=None, source_type=None, component_details=None, operation=None, action_details=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActionDTO - a model defined in Swagger

action_details

Gets the action_details of this ActionDTO. The details of the action.

Returns:The action_details of this ActionDTO. Return type:ActionDetailsDTO

attribute_map = {'action_details': 'actionDetails', 'component_details': 'componentDetails', 'id': 'id', 'operation': 'operation', 'source_id': 'sourceId', 'source_name': 'sourceName', 'source_type': 'sourceType', 'timestamp': 'timestamp', 'user_identity': 'userIdentity'}

component_details

Gets the component_details of this ActionDTO. The details of the source component.

Returns:The component_details of this ActionDTO. Return type:ComponentDetailsDTO

id

Gets the id of this ActionDTO. The action id.

Returns:The id of this ActionDTO. Return type:int

operation

Gets the operation of this ActionDTO. The operation that was performed.

Returns:The operation of this ActionDTO. Return type:str

source_id

Gets the source_id of this ActionDTO. The id of the source component.

Returns:The source_id of this ActionDTO. Return type:str

source_name

Gets the source_name of this ActionDTO. The name of the source component.

Returns:The source_name of this ActionDTO. Return type:str

source_type

Gets the source_type of this ActionDTO. The type of the source component.

Returns:The source_type of this ActionDTO. Return type:str

swagger_types = {'action_details': 'ActionDetailsDTO', 'component_details': 'ComponentDetailsDTO', 'id': 'int', 'operation': 'str', 'source_id': 'str', 'source_name': 'str', 'source_type': 'str', 'timestamp': 'str', 'user_identity': 'str'}

timestamp

Gets the timestamp of this ActionDTO. The timestamp of the action.

Returns:The timestamp of this ActionDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_identity

Gets the user_identity of this ActionDTO. The identity of the user that performed the action.

Returns:The user_identity of this ActionDTO. Return type:str

nipyapi.nifi.models.action_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.action_entity.ActionEntity(id=None, timestamp=None, source_id=None, can_read=None, action=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActionEntity - a model defined in Swagger

action

Gets the action of this ActionEntity.

Returns:The action of this ActionEntity. Return type:ActionDTO

attribute_map = {'action': 'action', 'can_read': 'canRead', 'id': 'id', 'source_id': 'sourceId', 'timestamp': 'timestamp'}

can_read

Gets the can_read of this ActionEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ActionEntity. Return type:bool

id

Gets the id of this ActionEntity.

Returns:The id of this ActionEntity. Return type:int

source_id

Gets the source_id of this ActionEntity.

Returns:The source_id of this ActionEntity. Return type:str

swagger_types = {'action': 'ActionDTO', 'can_read': 'bool', 'id': 'int', 'source_id': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this ActionEntity. The timestamp of the action.

Returns:The timestamp of this ActionEntity. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.activate_controller_services_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.activate_controller_services_entity.ActivateControllerServicesEntity(id=None, state=None, components=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ActivateControllerServicesEntity - a model defined in Swagger

attribute_map = {'components': 'components', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'state': 'state'}

components

Gets the components of this ActivateControllerServicesEntity. Optional services to schedule. If not specified, all authorized descendant controller services will be used.

Returns:The components of this ActivateControllerServicesEntity. Return type:dict(str, RevisionDTO)

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ActivateControllerServicesEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ActivateControllerServicesEntity. Return type:bool

id

Gets the id of this ActivateControllerServicesEntity. The id of the ProcessGroup

Returns:The id of this ActivateControllerServicesEntity. Return type:str

state

Gets the state of this ActivateControllerServicesEntity. The desired state of the descendant components

Returns:The state of this ActivateControllerServicesEntity. Return type:str

swagger_types = {'components': 'dict(str, RevisionDTO)', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.affected_component_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.affected_component_dto.AffectedComponentDTO(process_group_id=None, id=None, reference_type=None, name=None, state=None, active_thread_count=None, validation_errors=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AffectedComponentDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this AffectedComponentDTO. The number of active threads for the referencing component.

Returns:The active_thread_count of this AffectedComponentDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'id': 'id', 'name': 'name', 'process_group_id': 'processGroupId', 'reference_type': 'referenceType', 'state': 'state', 'validation_errors': 'validationErrors'}

id

Gets the id of this AffectedComponentDTO. The UUID of this component

Returns:The id of this AffectedComponentDTO. Return type:str

name

Gets the name of this AffectedComponentDTO. The name of this component.

Returns:The name of this AffectedComponentDTO. Return type:str

process_group_id

Gets the process_group_id of this AffectedComponentDTO. The UUID of the Process Group that this component is in

Returns:The process_group_id of this AffectedComponentDTO. Return type:str

reference_type

Gets the reference_type of this AffectedComponentDTO. The type of this component

Returns:The reference_type of this AffectedComponentDTO. Return type:str

state

Gets the state of this AffectedComponentDTO. The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.

Returns:The state of this AffectedComponentDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'id': 'str', 'name': 'str', 'process_group_id': 'str', 'reference_type': 'str', 'state': 'str', 'validation_errors': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

validation_errors

Gets the validation_errors of this AffectedComponentDTO. The validation errors for the component.

Returns:The validation_errors of this AffectedComponentDTO. Return type:list[str]

nipyapi.nifi.models.affected_component_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.affected_component_entity.AffectedComponentEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, process_group=None, reference_type=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AffectedComponentEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'process_group': 'processGroup', 'reference_type': 'referenceType', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this AffectedComponentEntity. The bulletins for this component.

Returns:The bulletins of this AffectedComponentEntity. Return type:list[BulletinEntity]

component

Gets the component of this AffectedComponentEntity.

Returns:The component of this AffectedComponentEntity. Return type:AffectedComponentDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this AffectedComponentEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this AffectedComponentEntity. Return type:bool

id

Gets the id of this AffectedComponentEntity. The id of the component.

Returns:The id of this AffectedComponentEntity. Return type:str

permissions

Gets the permissions of this AffectedComponentEntity. The permissions for this component.

Returns:The permissions of this AffectedComponentEntity. Return type:PermissionsDTO

position

Gets the position of this AffectedComponentEntity. The position of this component in the UI if applicable.

Returns:The position of this AffectedComponentEntity. Return type:PositionDTO

process_group

Gets the process_group of this AffectedComponentEntity. The Process Group that the component belongs to

Returns:The process_group of this AffectedComponentEntity. Return type:ProcessGroupNameDTO

reference_type

Gets the reference_type of this AffectedComponentEntity. The type of component referenced

Returns:The reference_type of this AffectedComponentEntity. Return type:str

revision

Gets the revision of this AffectedComponentEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this AffectedComponentEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'AffectedComponentDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'process_group': 'ProcessGroupNameDTO', 'reference_type': 'str', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this AffectedComponentEntity. The URI for futures requests to the component.

Returns:The uri of this AffectedComponentEntity. Return type:str

nipyapi.nifi.models.allowable_value_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.allowable_value_dto.AllowableValueDTO(display_name=None, value=None, description=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AllowableValueDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'display_name': 'displayName', 'value': 'value'}

description

Gets the description of this AllowableValueDTO. A description for this allowable value.

Returns:The description of this AllowableValueDTO. Return type:str

display_name

Gets the display_name of this AllowableValueDTO. A human readable value that is allowed for the property descriptor.

Returns:The display_name of this AllowableValueDTO. Return type:str

swagger_types = {'description': 'str', 'display_name': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this AllowableValueDTO. A value that is allowed for the property descriptor.

Returns:The value of this AllowableValueDTO. Return type:str

nipyapi.nifi.models.allowable_value_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.allowable_value_entity.AllowableValueEntity(allowable_value=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AllowableValueEntity - a model defined in Swagger

allowable_value

Gets the allowable_value of this AllowableValueEntity.

Returns:The allowable_value of this AllowableValueEntity. Return type:AllowableValueDTO

attribute_map = {'allowable_value': 'allowableValue', 'can_read': 'canRead'}

can_read

Gets the can_read of this AllowableValueEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this AllowableValueEntity. Return type:bool

swagger_types = {'allowable_value': 'AllowableValueDTO', 'can_read': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.attribute_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.attribute_dto.AttributeDTO(name=None, value=None, previous_value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

AttributeDTO - a model defined in Swagger

attribute_map = {'name': 'name', 'previous_value': 'previousValue', 'value': 'value'}

name

Gets the name of this AttributeDTO. The attribute name.

Returns:The name of this AttributeDTO. Return type:str

previous_value

Gets the previous_value of this AttributeDTO. The value of the attribute before the event took place.

Returns:The previous_value of this AttributeDTO. Return type:str

swagger_types = {'name': 'str', 'previous_value': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this AttributeDTO. The attribute value.

Returns:The value of this AttributeDTO. Return type:str

nipyapi.nifi.models.banner_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.banner_dto.BannerDTO(header_text=None, footer_text=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BannerDTO - a model defined in Swagger

attribute_map = {'footer_text': 'footerText', 'header_text': 'headerText'}

footer_text

Gets the footer_text of this BannerDTO. The footer text.

Returns:The footer_text of this BannerDTO. Return type:str

header_text

Gets the header_text of this BannerDTO. The header text.

Returns:The header_text of this BannerDTO. Return type:str

swagger_types = {'footer_text': 'str', 'header_text': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.banner_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.banner_entity.BannerEntity(banners=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BannerEntity - a model defined in Swagger

attribute_map = {'banners': 'banners'}

banners

Gets the banners of this BannerEntity.

Returns:The banners of this BannerEntity. Return type:BannerDTO

swagger_types = {'banners': 'BannerDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.batch_settings_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.batch_settings_dto.BatchSettingsDTO(count=None, size=None, duration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BatchSettingsDTO - a model defined in Swagger

attribute_map = {'count': 'count', 'duration': 'duration', 'size': 'size'}

count

Gets the count of this BatchSettingsDTO. Preferred number of flow files to include in a transaction.

Returns:The count of this BatchSettingsDTO. Return type:int

duration

Gets the duration of this BatchSettingsDTO. Preferred amount of time that a transaction should span.

Returns:The duration of this BatchSettingsDTO. Return type:str

size

Gets the size of this BatchSettingsDTO. Preferred number of bytes to include in a transaction.

Returns:The size of this BatchSettingsDTO. Return type:str

swagger_types = {'count': 'int', 'duration': 'str', 'size': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.batch_size module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.batch_size.BatchSize(count=None, size=None, duration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BatchSize - a model defined in Swagger

attribute_map = {'count': 'count', 'duration': 'duration', 'size': 'size'}

count

Gets the count of this BatchSize. Preferred number of flow files to include in a transaction.

Returns:The count of this BatchSize. Return type:int

duration

Gets the duration of this BatchSize. Preferred amount of time that a transaction should span.

Returns:The duration of this BatchSize. Return type:str

size

Gets the size of this BatchSize. Preferred number of bytes to include in a transaction.

Returns:The size of this BatchSize. Return type:str

swagger_types = {'count': 'int', 'duration': 'str', 'size': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bucket module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bucket.Bucket(link=None, identifier=None, name=None, created_timestamp=None, description=None, allow_bundle_redeploy=None, allow_public_read=None, permissions=None, revision=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Bucket - a model defined in Swagger

allow_bundle_redeploy

Gets the allow_bundle_redeploy of this Bucket. Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false.

Returns:The allow_bundle_redeploy of this Bucket. Return type:bool

allow_public_read

Gets the allow_public_read of this Bucket. Indicates if this bucket allows read access to unauthenticated anonymous users

Returns:The allow_public_read of this Bucket. Return type:bool

attribute_map = {'allow_bundle_redeploy': 'allowBundleRedeploy', 'allow_public_read': 'allowPublicRead', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'name': 'name', 'permissions': 'permissions', 'revision': 'revision'}

created_timestamp

Gets the created_timestamp of this Bucket. The timestamp of when the bucket was first created. This is set by the server at creation time.

Returns:The created_timestamp of this Bucket. Return type:int

description

Gets the description of this Bucket. A description of the bucket.

Returns:The description of this Bucket. Return type:str

identifier

Gets the identifier of this Bucket. An ID to uniquely identify this object.

Returns:The identifier of this Bucket. Return type:str

link

Gets the link of this Bucket. An WebLink to this entity.

Returns:The link of this Bucket. Return type:JaxbLink

name

Gets the name of this Bucket. The name of the bucket.

Returns:The name of this Bucket. Return type:str

permissions

Gets the permissions of this Bucket. The access that the current user has to this bucket.

Returns:The permissions of this Bucket. Return type:Permissions

revision

Gets the revision of this Bucket. The revision of this entity used for optimistic-locking during updates.

Returns:The revision of this Bucket. Return type:RevisionInfo

swagger_types = {'allow_bundle_redeploy': 'bool', 'allow_public_read': 'bool', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bucket_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bucket_dto.BucketDTO(id=None, name=None, description=None, created=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketDTO - a model defined in Swagger

attribute_map = {'created': 'created', 'description': 'description', 'id': 'id', 'name': 'name'}

created

Gets the created of this BucketDTO. The created timestamp of this bucket

Returns:The created of this BucketDTO. Return type:int

description

Gets the description of this BucketDTO. The bucket description

Returns:The description of this BucketDTO. Return type:str

id

Gets the id of this BucketDTO. The bucket identifier

Returns:The id of this BucketDTO. Return type:str

name

Gets the name of this BucketDTO. The bucket name

Returns:The name of this BucketDTO. Return type:str

swagger_types = {'created': 'int', 'description': 'str', 'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bucket_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bucket_entity.BucketEntity(id=None, bucket=None, permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketEntity - a model defined in Swagger

attribute_map = {'bucket': 'bucket', 'id': 'id', 'permissions': 'permissions'}

bucket

Gets the bucket of this BucketEntity.

Returns:The bucket of this BucketEntity. Return type:BucketDTO

id

Gets the id of this BucketEntity.

Returns:The id of this BucketEntity. Return type:str

permissions

Gets the permissions of this BucketEntity.

Returns:The permissions of this BucketEntity. Return type:PermissionsDTO

swagger_types = {'bucket': 'BucketDTO', 'id': 'str', 'permissions': 'PermissionsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.buckets_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.buckets_entity.BucketsEntity(buckets=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BucketsEntity - a model defined in Swagger

attribute_map = {'buckets': 'buckets'}

buckets

Gets the buckets of this BucketsEntity.

Returns:The buckets of this BucketsEntity. Return type:list[BucketEntity]

swagger_types = {'buckets': 'list[BucketEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_board_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bulletin_board_dto.BulletinBoardDTO(bulletins=None, generated=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinBoardDTO - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'generated': 'generated'}

bulletins

Gets the bulletins of this BulletinBoardDTO. The bulletins in the bulletin board, that matches the supplied request.

Returns:The bulletins of this BulletinBoardDTO. Return type:list[BulletinEntity]

generated

Gets the generated of this BulletinBoardDTO. The timestamp when this report was generated.

Returns:The generated of this BulletinBoardDTO. Return type:str

swagger_types = {'bulletins': 'list[BulletinEntity]', 'generated': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_board_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bulletin_board_entity.BulletinBoardEntity(bulletin_board=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinBoardEntity - a model defined in Swagger

attribute_map = {'bulletin_board': 'bulletinBoard'}

bulletin_board

Gets the bulletin_board of this BulletinBoardEntity.

Returns:The bulletin_board of this BulletinBoardEntity. Return type:BulletinBoardDTO

swagger_types = {'bulletin_board': 'BulletinBoardDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bulletin_dto.BulletinDTO(id=None, node_address=None, category=None, group_id=None, source_id=None, source_name=None, level=None, message=None, timestamp=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinDTO - a model defined in Swagger

attribute_map = {'category': 'category', 'group_id': 'groupId', 'id': 'id', 'level': 'level', 'message': 'message', 'node_address': 'nodeAddress', 'source_id': 'sourceId', 'source_name': 'sourceName', 'timestamp': 'timestamp'}

category

Gets the category of this BulletinDTO. The category of this bulletin.

Returns:The category of this BulletinDTO. Return type:str

group_id

Gets the group_id of this BulletinDTO. The group id of the source component.

Returns:The group_id of this BulletinDTO. Return type:str

id

Gets the id of this BulletinDTO. The id of the bulletin.

Returns:The id of this BulletinDTO. Return type:int

level

Gets the level of this BulletinDTO. The level of the bulletin.

Returns:The level of this BulletinDTO. Return type:str

message

Gets the message of this BulletinDTO. The bulletin message.

Returns:The message of this BulletinDTO. Return type:str

node_address

Gets the node_address of this BulletinDTO. If clustered, the address of the node from which the bulletin originated.

Returns:The node_address of this BulletinDTO. Return type:str

source_id

Gets the source_id of this BulletinDTO. The id of the source component.

Returns:The source_id of this BulletinDTO. Return type:str

source_name

Gets the source_name of this BulletinDTO. The name of the source component.

Returns:The source_name of this BulletinDTO. Return type:str

swagger_types = {'category': 'str', 'group_id': 'str', 'id': 'int', 'level': 'str', 'message': 'str', 'node_address': 'str', 'source_id': 'str', 'source_name': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this BulletinDTO. When this bulletin was generated.

Returns:The timestamp of this BulletinDTO. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bulletin_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bulletin_entity.BulletinEntity(id=None, group_id=None, source_id=None, timestamp=None, node_address=None, can_read=None, bulletin=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BulletinEntity - a model defined in Swagger

attribute_map = {'bulletin': 'bulletin', 'can_read': 'canRead', 'group_id': 'groupId', 'id': 'id', 'node_address': 'nodeAddress', 'source_id': 'sourceId', 'timestamp': 'timestamp'}

bulletin

Gets the bulletin of this BulletinEntity.

Returns:The bulletin of this BulletinEntity. Return type:BulletinDTO

can_read

Gets the can_read of this BulletinEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this BulletinEntity. Return type:bool

group_id

Gets the group_id of this BulletinEntity.

Returns:The group_id of this BulletinEntity. Return type:str

id

Gets the id of this BulletinEntity.

Returns:The id of this BulletinEntity. Return type:int

node_address

Gets the node_address of this BulletinEntity.

Returns:The node_address of this BulletinEntity. Return type:str

source_id

Gets the source_id of this BulletinEntity.

Returns:The source_id of this BulletinEntity. Return type:str

swagger_types = {'bulletin': 'BulletinDTO', 'can_read': 'bool', 'group_id': 'str', 'id': 'int', 'node_address': 'str', 'source_id': 'str', 'timestamp': 'str'}

timestamp

Gets the timestamp of this BulletinEntity. When this bulletin was generated.

Returns:The timestamp of this BulletinEntity. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.bundle module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bundle.Bundle(group=None, artifact=None, version=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

Bundle - a model defined in Swagger

artifact

Gets the artifact of this Bundle. The artifact of the bundle

Returns:The artifact of this Bundle. Return type:str

attribute_map = {'artifact': 'artifact', 'group': 'group', 'version': 'version'}

group

Gets the group of this Bundle. The group of the bundle

Returns:The group of this Bundle. Return type:str

swagger_types = {'artifact': 'str', 'group': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this Bundle. The version of the bundle

Returns:The version of this Bundle. Return type:str

nipyapi.nifi.models.bundle_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.bundle_dto.BundleDTO(group=None, artifact=None, version=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

BundleDTO - a model defined in Swagger

artifact

Gets the artifact of this BundleDTO. The artifact of the bundle.

Returns:The artifact of this BundleDTO. Return type:str

attribute_map = {'artifact': 'artifact', 'group': 'group', 'version': 'version'}

group

Gets the group of this BundleDTO. The group of the bundle.

Returns:The group of this BundleDTO. Return type:str

swagger_types = {'artifact': 'str', 'group': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this BundleDTO. The version of the bundle.

Returns:The version of this BundleDTO. Return type:str

nipyapi.nifi.models.cluste_summary_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.cluste_summary_entity.ClusteSummaryEntity(cluster_summary=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusteSummaryEntity - a model defined in Swagger

attribute_map = {'cluster_summary': 'clusterSummary'}

cluster_summary

Gets the cluster_summary of this ClusteSummaryEntity.

Returns:The cluster_summary of this ClusteSummaryEntity. Return type:ClusterSummaryDTO

swagger_types = {'cluster_summary': 'ClusterSummaryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.cluster_dto.ClusterDTO(nodes=None, generated=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterDTO - a model defined in Swagger

attribute_map = {'generated': 'generated', 'nodes': 'nodes'}

generated

Gets the generated of this ClusterDTO. The timestamp the report was generated.

Returns:The generated of this ClusterDTO. Return type:str

nodes

Gets the nodes of this ClusterDTO. The collection of nodes that are part of the cluster.

Returns:The nodes of this ClusterDTO. Return type:list[NodeDTO]

swagger_types = {'generated': 'str', 'nodes': 'list[NodeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.cluster_entity.ClusterEntity(cluster=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterEntity - a model defined in Swagger

attribute_map = {'cluster': 'cluster'}

cluster

Gets the cluster of this ClusterEntity.

Returns:The cluster of this ClusterEntity. Return type:ClusterDTO

swagger_types = {'cluster': 'ClusterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_search_results_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.cluster_search_results_entity.ClusterSearchResultsEntity(node_results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterSearchResultsEntity - a model defined in Swagger

attribute_map = {'node_results': 'nodeResults'}

node_results

Gets the node_results of this ClusterSearchResultsEntity.

Returns:The node_results of this ClusterSearchResultsEntity. Return type:list[NodeSearchResultDTO]

swagger_types = {'node_results': 'list[NodeSearchResultDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.cluster_summary_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.cluster_summary_dto.ClusterSummaryDTO(connected_nodes=None, connected_node_count=None, total_node_count=None, clustered=None, connected_to_cluster=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ClusterSummaryDTO - a model defined in Swagger

attribute_map = {'clustered': 'clustered', 'connected_node_count': 'connectedNodeCount', 'connected_nodes': 'connectedNodes', 'connected_to_cluster': 'connectedToCluster', 'total_node_count': 'totalNodeCount'}

clustered

Gets the clustered of this ClusterSummaryDTO. Whether this NiFi instance is clustered.

Returns:The clustered of this ClusterSummaryDTO. Return type:bool

connected_node_count

Gets the connected_node_count of this ClusterSummaryDTO. The number of nodes that are currently connected to the cluster

Returns:The connected_node_count of this ClusterSummaryDTO. Return type:int

connected_nodes

Gets the connected_nodes of this ClusterSummaryDTO. When clustered, reports the number of nodes connected vs the number of nodes in the cluster.

Returns:The connected_nodes of this ClusterSummaryDTO. Return type:str

connected_to_cluster

Gets the connected_to_cluster of this ClusterSummaryDTO. Whether this NiFi instance is connected to a cluster.

Returns:The connected_to_cluster of this ClusterSummaryDTO. Return type:bool

swagger_types = {'clustered': 'bool', 'connected_node_count': 'int', 'connected_nodes': 'str', 'connected_to_cluster': 'bool', 'total_node_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total_node_count

Gets the total_node_count of this ClusterSummaryDTO. The number of nodes in the cluster, regardless of whether or not they are connected

Returns:The total_node_count of this ClusterSummaryDTO. Return type:int

nipyapi.nifi.models.component_details_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_details_dto.ComponentDetailsDTO

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentDetailsDTO - a model defined in Swagger

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_difference_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_difference_dto.ComponentDifferenceDTO(component_type=None, component_id=None, component_name=None, process_group_id=None, differences=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentDifferenceDTO - a model defined in Swagger

attribute_map = {'component_id': 'componentId', 'component_name': 'componentName', 'component_type': 'componentType', 'differences': 'differences', 'process_group_id': 'processGroupId'}

component_id

Gets the component_id of this ComponentDifferenceDTO. The ID of the component

Returns:The component_id of this ComponentDifferenceDTO. Return type:str

component_name

Gets the component_name of this ComponentDifferenceDTO. The name of the component

Returns:The component_name of this ComponentDifferenceDTO. Return type:str

component_type

Gets the component_type of this ComponentDifferenceDTO. The type of component

Returns:The component_type of this ComponentDifferenceDTO. Return type:str

differences

Gets the differences of this ComponentDifferenceDTO. The differences in the component between the two flows

Returns:The differences of this ComponentDifferenceDTO. Return type:list[DifferenceDTO]

process_group_id

Gets the process_group_id of this ComponentDifferenceDTO. The ID of the Process Group that the component belongs to

Returns:The process_group_id of this ComponentDifferenceDTO. Return type:str

swagger_types = {'component_id': 'str', 'component_name': 'str', 'component_type': 'str', 'differences': 'list[DifferenceDTO]', 'process_group_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_history_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_history_dto.ComponentHistoryDTO(component_id=None, property_history=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentHistoryDTO - a model defined in Swagger

attribute_map = {'component_id': 'componentId', 'property_history': 'propertyHistory'}

component_id

Gets the component_id of this ComponentHistoryDTO. The component id.

Returns:The component_id of this ComponentHistoryDTO. Return type:str

property_history

Gets the property_history of this ComponentHistoryDTO. The history for the properties of the component.

Returns:The property_history of this ComponentHistoryDTO. Return type:dict(str, PropertyHistoryDTO)

swagger_types = {'component_id': 'str', 'property_history': 'dict(str, PropertyHistoryDTO)'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_history_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_history_entity.ComponentHistoryEntity(component_history=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentHistoryEntity - a model defined in Swagger

attribute_map = {'component_history': 'componentHistory'}

component_history

Gets the component_history of this ComponentHistoryEntity.

Returns:The component_history of this ComponentHistoryEntity. Return type:ComponentHistoryDTO

swagger_types = {'component_history': 'ComponentHistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_reference_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_reference_dto.ComponentReferenceDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentReferenceDTO - a model defined in Swagger

attribute_map = {'id': 'id', 'name': 'name', 'parent_group_id': 'parentGroupId', 'position': 'position', 'versioned_component_id': 'versionedComponentId'}

id

Gets the id of this ComponentReferenceDTO. The id of the component.

Returns:The id of this ComponentReferenceDTO. Return type:str

name

Gets the name of this ComponentReferenceDTO. The name of the component.

Returns:The name of this ComponentReferenceDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ComponentReferenceDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ComponentReferenceDTO. Return type:str

position

Gets the position of this ComponentReferenceDTO. The position of this component in the UI if applicable.

Returns:The position of this ComponentReferenceDTO. Return type:PositionDTO

swagger_types = {'id': 'str', 'name': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this ComponentReferenceDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ComponentReferenceDTO. Return type:str

nipyapi.nifi.models.component_reference_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_reference_entity.ComponentReferenceEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, parent_group_id=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentReferenceEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'parent_group_id': 'parentGroupId', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this ComponentReferenceEntity. The bulletins for this component.

Returns:The bulletins of this ComponentReferenceEntity. Return type:list[BulletinEntity]

component

Gets the component of this ComponentReferenceEntity.

Returns:The component of this ComponentReferenceEntity. Return type:ComponentReferenceDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ComponentReferenceEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ComponentReferenceEntity. Return type:bool

id

Gets the id of this ComponentReferenceEntity. The id of the component.

Returns:The id of this ComponentReferenceEntity. Return type:str

parent_group_id

Gets the parent_group_id of this ComponentReferenceEntity. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ComponentReferenceEntity. Return type:str

permissions

Gets the permissions of this ComponentReferenceEntity. The permissions for this component.

Returns:The permissions of this ComponentReferenceEntity. Return type:PermissionsDTO

position

Gets the position of this ComponentReferenceEntity. The position of this component in the UI if applicable.

Returns:The position of this ComponentReferenceEntity. Return type:PositionDTO

revision

Gets the revision of this ComponentReferenceEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ComponentReferenceEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ComponentReferenceDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'parent_group_id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ComponentReferenceEntity. The URI for futures requests to the component.

Returns:The uri of this ComponentReferenceEntity. Return type:str

nipyapi.nifi.models.component_search_result_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_search_result_dto.ComponentSearchResultDTO(id=None, group_id=None, parent_group=None, versioned_group=None, name=None, matches=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentSearchResultDTO - a model defined in Swagger

attribute_map = {'group_id': 'groupId', 'id': 'id', 'matches': 'matches', 'name': 'name', 'parent_group': 'parentGroup', 'versioned_group': 'versionedGroup'}

group_id

Gets the group_id of this ComponentSearchResultDTO. The group id of the component that matched the search.

Returns:The group_id of this ComponentSearchResultDTO. Return type:str

id

Gets the id of this ComponentSearchResultDTO. The id of the component that matched the search.

Returns:The id of this ComponentSearchResultDTO. Return type:str

matches

Gets the matches of this ComponentSearchResultDTO. What matched the search from the component.

Returns:The matches of this ComponentSearchResultDTO. Return type:list[str]

name

Gets the name of this ComponentSearchResultDTO. The name of the component that matched the search.

Returns:The name of this ComponentSearchResultDTO. Return type:str

parent_group

Gets the parent_group of this ComponentSearchResultDTO. The parent group of the component that matched the search.

Returns:The parent_group of this ComponentSearchResultDTO. Return type:SearchResultGroupDTO

swagger_types = {'group_id': 'str', 'id': 'str', 'matches': 'list[str]', 'name': 'str', 'parent_group': 'SearchResultGroupDTO', 'versioned_group': 'SearchResultGroupDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_group

Gets the versioned_group of this ComponentSearchResultDTO. The nearest versioned ancestor group of the component that matched the search.

Returns:The versioned_group of this ComponentSearchResultDTO. Return type:SearchResultGroupDTO

nipyapi.nifi.models.component_state_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_state_dto.ComponentStateDTO(component_id=None, state_description=None, cluster_state=None, local_state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentStateDTO - a model defined in Swagger

attribute_map = {'cluster_state': 'clusterState', 'component_id': 'componentId', 'local_state': 'localState', 'state_description': 'stateDescription'}

cluster_state

Gets the cluster_state of this ComponentStateDTO. The cluster state for this component, or null if this NiFi is a standalone instance.

Returns:The cluster_state of this ComponentStateDTO. Return type:StateMapDTO

component_id

Gets the component_id of this ComponentStateDTO. The component identifier.

Returns:The component_id of this ComponentStateDTO. Return type:str

local_state

Gets the local_state of this ComponentStateDTO. The local state for this component.

Returns:The local_state of this ComponentStateDTO. Return type:StateMapDTO

state_description

Gets the state_description of this ComponentStateDTO. Description of the state this component persists.

Returns:The state_description of this ComponentStateDTO. Return type:str

swagger_types = {'cluster_state': 'StateMapDTO', 'component_id': 'str', 'local_state': 'StateMapDTO', 'state_description': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.component_state_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.component_state_entity.ComponentStateEntity(component_state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ComponentStateEntity - a model defined in Swagger

attribute_map = {'component_state': 'componentState'}

component_state

Gets the component_state of this ComponentStateEntity. The component state.

Returns:The component_state of this ComponentStateEntity. Return type:ComponentStateDTO

swagger_types = {'component_state': 'ComponentStateDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connectable_component module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connectable_component.ConnectableComponent(id=None, type=None, group_id=None, name=None, comments=None, instance_identifier=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectableComponent - a model defined in Swagger

attribute_map = {'comments': 'comments', 'group_id': 'groupId', 'id': 'id', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'type': 'type'}

comments

Gets the comments of this ConnectableComponent. The comments for the connectable component.

Returns:The comments of this ConnectableComponent. Return type:str

group_id

Gets the group_id of this ConnectableComponent. The id of the group that the connectable component resides in

Returns:The group_id of this ConnectableComponent. Return type:str

id

Gets the id of this ConnectableComponent. The id of the connectable component.

Returns:The id of this ConnectableComponent. Return type:str

instance_identifier

Gets the instance_identifier of this ConnectableComponent. The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Returns:The instance_identifier of this ConnectableComponent. Return type:str

name

Gets the name of this ConnectableComponent. The name of the connectable component

Returns:The name of this ConnectableComponent. Return type:str

swagger_types = {'comments': 'str', 'group_id': 'str', 'id': 'str', 'instance_identifier': 'str', 'name': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ConnectableComponent. The type of component the connectable is.

Returns:The type of this ConnectableComponent. Return type:str

nipyapi.nifi.models.connectable_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connectable_dto.ConnectableDTO(id=None, versioned_component_id=None, type=None, group_id=None, name=None, running=None, transmitting=None, exists=None, comments=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectableDTO - a model defined in Swagger

attribute_map = {'comments': 'comments', 'exists': 'exists', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'running': 'running', 'transmitting': 'transmitting', 'type': 'type', 'versioned_component_id': 'versionedComponentId'}

comments

Gets the comments of this ConnectableDTO. The comments for the connectable component.

Returns:The comments of this ConnectableDTO. Return type:str

exists

Gets the exists of this ConnectableDTO. If the connectable component represents a remote port, indicates if the target exists.

Returns:The exists of this ConnectableDTO. Return type:bool

group_id

Gets the group_id of this ConnectableDTO. The id of the group that the connectable component resides in

Returns:The group_id of this ConnectableDTO. Return type:str

id

Gets the id of this ConnectableDTO. The id of the connectable component.

Returns:The id of this ConnectableDTO. Return type:str

name

Gets the name of this ConnectableDTO. The name of the connectable component

Returns:The name of this ConnectableDTO. Return type:str

running

Gets the running of this ConnectableDTO. Reflects the current state of the connectable component.

Returns:The running of this ConnectableDTO. Return type:bool

swagger_types = {'comments': 'str', 'exists': 'bool', 'group_id': 'str', 'id': 'str', 'name': 'str', 'running': 'bool', 'transmitting': 'bool', 'type': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transmitting

Gets the transmitting of this ConnectableDTO. If the connectable component represents a remote port, indicates if the target is configured to transmit.

Returns:The transmitting of this ConnectableDTO. Return type:bool

type

Gets the type of this ConnectableDTO. The type of component the connectable is.

Returns:The type of this ConnectableDTO. Return type:str

versioned_component_id

Gets the versioned_component_id of this ConnectableDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ConnectableDTO. Return type:str

nipyapi.nifi.models.connection_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connection_dto.ConnectionDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, source=None, destination=None, name=None, label_index=None, getz_index=None, selected_relationships=None, available_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, load_balance_partition_attribute=None, load_balance_compression=None, load_balance_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionDTO - a model defined in Swagger

attribute_map = {'available_relationships': 'availableRelationships', 'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'getz_index': 'getzIndex', 'id': 'id', 'label_index': 'labelIndex', 'load_balance_compression': 'loadBalanceCompression', 'load_balance_partition_attribute': 'loadBalancePartitionAttribute', 'load_balance_status': 'loadBalanceStatus', 'load_balance_strategy': 'loadBalanceStrategy', 'name': 'name', 'parent_group_id': 'parentGroupId', 'position': 'position', 'prioritizers': 'prioritizers', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'versioned_component_id': 'versionedComponentId'}

available_relationships

Gets the available_relationships of this ConnectionDTO. The relationships that the source of the connection currently supports.

Returns:The available_relationships of this ConnectionDTO. Return type:list[str]

back_pressure_data_size_threshold

Gets the back_pressure_data_size_threshold of this ConnectionDTO. The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_data_size_threshold of this ConnectionDTO. Return type:str

back_pressure_object_threshold

Gets the back_pressure_object_threshold of this ConnectionDTO. The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.

Returns:The back_pressure_object_threshold of this ConnectionDTO. Return type:int

bends

Gets the bends of this ConnectionDTO. The bend points on the connection.

Returns:The bends of this ConnectionDTO. Return type:list[PositionDTO]

destination

Gets the destination of this ConnectionDTO. The destination of the connection.

Returns:The destination of this ConnectionDTO. Return type:ConnectableDTO

flow_file_expiration

Gets the flow_file_expiration of this ConnectionDTO. The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.

Returns:The flow_file_expiration of this ConnectionDTO. Return type:str

getz_index

Gets the getz_index of this ConnectionDTO. The z index of the connection.

Returns:The getz_index of this ConnectionDTO. Return type:int

id

Gets the id of this ConnectionDTO. The id of the component.

Returns:The id of this ConnectionDTO. Return type:str

label_index

Gets the label_index of this ConnectionDTO. The index of the bend point where to place the connection label.

Returns:The label_index of this ConnectionDTO. Return type:int

load_balance_compression

Gets the load_balance_compression of this ConnectionDTO. Whether or not data should be compressed when being transferred between nodes in the cluster.

Returns:The load_balance_compression of this ConnectionDTO. Return type:str

load_balance_partition_attribute

Gets the load_balance_partition_attribute of this ConnectionDTO. The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE

Returns:The load_balance_partition_attribute of this ConnectionDTO. Return type:str

load_balance_status

Gets the load_balance_status of this ConnectionDTO. The current status of the Connection’s Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.

Returns:The load_balance_status of this ConnectionDTO. Return type:str

load_balance_strategy

Gets the load_balance_strategy of this ConnectionDTO. How to load balance the data in this Connection across the nodes in the cluster.

Returns:The load_balance_strategy of this ConnectionDTO. Return type:str

name

Gets the name of this ConnectionDTO. The name of the connection.

Returns:The name of this ConnectionDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ConnectionDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ConnectionDTO. Return type:str

position

Gets the position of this ConnectionDTO. The position of this component in the UI if applicable.

Returns:The position of this ConnectionDTO. Return type:PositionDTO

prioritizers

Gets the prioritizers of this ConnectionDTO. The comparators used to prioritize the queue.

Returns:The prioritizers of this ConnectionDTO. Return type:list[str]

selected_relationships

Gets the selected_relationships of this ConnectionDTO. The selected relationship that comprise the connection.

Returns:The selected_relationships of this ConnectionDTO. Return type:list[str]

source

Gets the source of this ConnectionDTO. The source of the connection.

Returns:The source of this ConnectionDTO. Return type:ConnectableDTO

swagger_types = {'available_relationships': 'list[str]', 'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[PositionDTO]', 'destination': 'ConnectableDTO', 'flow_file_expiration': 'str', 'getz_index': 'int', 'id': 'str', 'label_index': 'int', 'load_balance_compression': 'str', 'load_balance_partition_attribute': 'str', 'load_balance_status': 'str', 'load_balance_strategy': 'str', 'name': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'prioritizers': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this ConnectionDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ConnectionDTO. Return type:str

nipyapi.nifi.models.connection_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connection_entity.ConnectionEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, bends=None, label_index=None, getz_index=None, source_id=None, source_group_id=None, source_type=None, destination_id=None, destination_group_id=None, destination_type=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionEntity - a model defined in Swagger

attribute_map = {'bends': 'bends', 'bulletins': 'bulletins', 'component': 'component', 'destination_group_id': 'destinationGroupId', 'destination_id': 'destinationId', 'destination_type': 'destinationType', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'getz_index': 'getzIndex', 'id': 'id', 'label_index': 'labelIndex', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'source_group_id': 'sourceGroupId', 'source_id': 'sourceId', 'source_type': 'sourceType', 'status': 'status', 'uri': 'uri'}

bends

Gets the bends of this ConnectionEntity. The bend points on the connection.

Returns:The bends of this ConnectionEntity. Return type:list[PositionDTO]

bulletins

Gets the bulletins of this ConnectionEntity. The bulletins for this component.

Returns:The bulletins of this ConnectionEntity. Return type:list[BulletinEntity]

component

Gets the component of this ConnectionEntity.

Returns:The component of this ConnectionEntity. Return type:ConnectionDTO

destination_group_id

Gets the destination_group_id of this ConnectionEntity. The identifier of the group of the destination of this connection.

Returns:The destination_group_id of this ConnectionEntity. Return type:str

destination_id

Gets the destination_id of this ConnectionEntity. The identifier of the destination of this connection.

Returns:The destination_id of this ConnectionEntity. Return type:str

destination_type

Gets the destination_type of this ConnectionEntity. The type of component the destination connectable is.

Returns:The destination_type of this ConnectionEntity. Return type:str

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ConnectionEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ConnectionEntity. Return type:bool

getz_index

Gets the getz_index of this ConnectionEntity. The z index of the connection.

Returns:The getz_index of this ConnectionEntity. Return type:int

id

Gets the id of this ConnectionEntity. The id of the component.

Returns:The id of this ConnectionEntity. Return type:str

label_index

Gets the label_index of this ConnectionEntity. The index of the bend point where to place the connection label.

Returns:The label_index of this ConnectionEntity. Return type:int

permissions

Gets the permissions of this ConnectionEntity. The permissions for this component.

Returns:The permissions of this ConnectionEntity. Return type:PermissionsDTO

position

Gets the position of this ConnectionEntity. The position of this component in the UI if applicable.

Returns:The position of this ConnectionEntity. Return type:PositionDTO

revision

Gets the revision of this ConnectionEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ConnectionEntity. Return type:RevisionDTO

source_group_id

Gets the source_group_id of this ConnectionEntity. The identifier of the group of the source of this connection.

Returns:The source_group_id of this ConnectionEntity. Return type:str

source_id

Gets the source_id of this ConnectionEntity. The identifier of the source of this connection.

Returns:The source_id of this ConnectionEntity. Return type:str

source_type

Gets the source_type of this ConnectionEntity. The type of component the source connectable is.

Returns:The source_type of this ConnectionEntity. Return type:str

status

Gets the status of this ConnectionEntity. The status of the connection.

Returns:The status of this ConnectionEntity. Return type:ConnectionStatusDTO

swagger_types = {'bends': 'list[PositionDTO]', 'bulletins': 'list[BulletinEntity]', 'component': 'ConnectionDTO', 'destination_group_id': 'str', 'destination_id': 'str', 'destination_type': 'str', 'disconnected_node_acknowledged': 'bool', 'getz_index': 'int', 'id': 'str', 'label_index': 'int', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'source_group_id': 'str', 'source_id': 'str', 'source_type': 'str', 'status': 'ConnectionStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ConnectionEntity. The URI for futures requests to the component.

Returns:The uri of this ConnectionEntity. Return type:str

nipyapi.nifi.models.connection_status_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connection_status_dto.ConnectionStatusDTO(id=None, group_id=None, name=None, stats_last_refreshed=None, source_id=None, source_name=None, destination_id=None, destination_name=None, aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this ConnectionStatusDTO. The status snapshot that represents the aggregate stats of the cluster

Returns:The aggregate_snapshot of this ConnectionStatusDTO. Return type:ConnectionStatusSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'destination_id': 'destinationId', 'destination_name': 'destinationName', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'source_id': 'sourceId', 'source_name': 'sourceName', 'stats_last_refreshed': 'statsLastRefreshed'}

destination_id

Gets the destination_id of this ConnectionStatusDTO. The ID of the destination component

Returns:The destination_id of this ConnectionStatusDTO. Return type:str

destination_name

Gets the destination_name of this ConnectionStatusDTO. The name of the destination component

Returns:The destination_name of this ConnectionStatusDTO. Return type:str

group_id

Gets the group_id of this ConnectionStatusDTO. The ID of the Process Group that the connection belongs to

Returns:The group_id of this ConnectionStatusDTO. Return type:str

id

Gets the id of this ConnectionStatusDTO. The ID of the connection

Returns:The id of this ConnectionStatusDTO. Return type:str

name

Gets the name of this ConnectionStatusDTO. The name of the connection

Returns:The name of this ConnectionStatusDTO. Return type:str

node_snapshots

Gets the node_snapshots of this ConnectionStatusDTO. A list of status snapshots for each node

Returns:The node_snapshots of this ConnectionStatusDTO. Return type:list[NodeConnectionStatusSnapshotDTO]

source_id

Gets the source_id of this ConnectionStatusDTO. The ID of the source component

Returns:The source_id of this ConnectionStatusDTO. Return type:str

source_name

Gets the source_name of this ConnectionStatusDTO. The name of the source component

Returns:The source_name of this ConnectionStatusDTO. Return type:str

stats_last_refreshed

Gets the stats_last_refreshed of this ConnectionStatusDTO. The timestamp of when the stats were last refreshed

Returns:The stats_last_refreshed of this ConnectionStatusDTO. Return type:str

swagger_types = {'aggregate_snapshot': 'ConnectionStatusSnapshotDTO', 'destination_id': 'str', 'destination_name': 'str', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeConnectionStatusSnapshotDTO]', 'source_id': 'str', 'source_name': 'str', 'stats_last_refreshed': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connection_status_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connection_status_entity.ConnectionStatusEntity(connection_status=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'connection_status': 'connectionStatus'}

can_read

Gets the can_read of this ConnectionStatusEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ConnectionStatusEntity. Return type:bool

connection_status

Gets the connection_status of this ConnectionStatusEntity.

Returns:The connection_status of this ConnectionStatusEntity. Return type:ConnectionStatusDTO

swagger_types = {'can_read': 'bool', 'connection_status': 'ConnectionStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connection_status_snapshot_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connection_status_snapshot_dto.ConnectionStatusSnapshotDTO(id=None, group_id=None, name=None, source_id=None, source_name=None, destination_id=None, destination_name=None, predictions=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, flow_files_queued=None, bytes_queued=None, queued=None, queued_size=None, queued_count=None, percent_use_count=None, percent_use_bytes=None, flow_file_availability=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusSnapshotDTO - a model defined in Swagger

attribute_map = {'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_queued': 'bytesQueued', 'destination_id': 'destinationId', 'destination_name': 'destinationName', 'flow_file_availability': 'flowFileAvailability', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'flow_files_queued': 'flowFilesQueued', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'name': 'name', 'output': 'output', 'percent_use_bytes': 'percentUseBytes', 'percent_use_count': 'percentUseCount', 'predictions': 'predictions', 'queued': 'queued', 'queued_count': 'queuedCount', 'queued_size': 'queuedSize', 'source_id': 'sourceId', 'source_name': 'sourceName'}

bytes_in

Gets the bytes_in of this ConnectionStatusSnapshotDTO. The size of the FlowFiles that have come into the connection in the last 5 minutes.

Returns:The bytes_in of this ConnectionStatusSnapshotDTO. Return type:int

bytes_out

Gets the bytes_out of this ConnectionStatusSnapshotDTO. The number of bytes that have left the connection in the last 5 minutes.

Returns:The bytes_out of this ConnectionStatusSnapshotDTO. Return type:int

bytes_queued

Gets the bytes_queued of this ConnectionStatusSnapshotDTO. The size of the FlowFiles that are currently queued in the connection.

Returns:The bytes_queued of this ConnectionStatusSnapshotDTO. Return type:int

destination_id

Gets the destination_id of this ConnectionStatusSnapshotDTO. The id of the destination of the connection.

Returns:The destination_id of this ConnectionStatusSnapshotDTO. Return type:str

destination_name

Gets the destination_name of this ConnectionStatusSnapshotDTO. The name of the destination of the connection.

Returns:The destination_name of this ConnectionStatusSnapshotDTO. Return type:str

flow_file_availability

Gets the flow_file_availability of this ConnectionStatusSnapshotDTO. The availability of FlowFiles in this connection

Returns:The flow_file_availability of this ConnectionStatusSnapshotDTO. Return type:str

flow_files_in

Gets the flow_files_in of this ConnectionStatusSnapshotDTO. The number of FlowFiles that have come into the connection in the last 5 minutes.

Returns:The flow_files_in of this ConnectionStatusSnapshotDTO. Return type:int

flow_files_out

Gets the flow_files_out of this ConnectionStatusSnapshotDTO. The number of FlowFiles that have left the connection in the last 5 minutes.

Returns:The flow_files_out of this ConnectionStatusSnapshotDTO. Return type:int

flow_files_queued

Gets the flow_files_queued of this ConnectionStatusSnapshotDTO. The number of FlowFiles that are currently queued in the connection.

Returns:The flow_files_queued of this ConnectionStatusSnapshotDTO. Return type:int

group_id

Gets the group_id of this ConnectionStatusSnapshotDTO. The id of the process group the connection belongs to.

Returns:The group_id of this ConnectionStatusSnapshotDTO. Return type:str

id

Gets the id of this ConnectionStatusSnapshotDTO. The id of the connection.

Returns:The id of this ConnectionStatusSnapshotDTO. Return type:str

input

Gets the input of this ConnectionStatusSnapshotDTO. The input count/size for the connection in the last 5 minutes, pretty printed.

Returns:The input of this ConnectionStatusSnapshotDTO. Return type:str

name

Gets the name of this ConnectionStatusSnapshotDTO. The name of the connection.

Returns:The name of this ConnectionStatusSnapshotDTO. Return type:str

output

Gets the output of this ConnectionStatusSnapshotDTO. The output count/sie for the connection in the last 5 minutes, pretty printed.

Returns:The output of this ConnectionStatusSnapshotDTO. Return type:str

percent_use_bytes

Gets the percent_use_bytes of this ConnectionStatusSnapshotDTO. Connection percent use regarding queued flow files size and backpressure threshold if configured.

Returns:The percent_use_bytes of this ConnectionStatusSnapshotDTO. Return type:int

percent_use_count

Gets the percent_use_count of this ConnectionStatusSnapshotDTO. Connection percent use regarding queued flow files count and backpressure threshold if configured.

Returns:The percent_use_count of this ConnectionStatusSnapshotDTO. Return type:int

predictions

Gets the predictions of this ConnectionStatusSnapshotDTO. Predictions, if available, for this connection (null if not available)

Returns:The predictions of this ConnectionStatusSnapshotDTO. Return type:ConnectionStatusPredictionsSnapshotDTO

queued

Gets the queued of this ConnectionStatusSnapshotDTO. The total count and size of queued flowfiles formatted.

Returns:The queued of this ConnectionStatusSnapshotDTO. Return type:str

queued_count

Gets the queued_count of this ConnectionStatusSnapshotDTO. The number of flowfiles that are queued, pretty printed.

Returns:The queued_count of this ConnectionStatusSnapshotDTO. Return type:str

queued_size

Gets the queued_size of this ConnectionStatusSnapshotDTO. The total size of flowfiles that are queued formatted.

Returns:The queued_size of this ConnectionStatusSnapshotDTO. Return type:str

source_id

Gets the source_id of this ConnectionStatusSnapshotDTO. The id of the source of the connection.

Returns:The source_id of this ConnectionStatusSnapshotDTO. Return type:str

source_name

Gets the source_name of this ConnectionStatusSnapshotDTO. The name of the source of the connection.

Returns:The source_name of this ConnectionStatusSnapshotDTO. Return type:str

swagger_types = {'bytes_in': 'int', 'bytes_out': 'int', 'bytes_queued': 'int', 'destination_id': 'str', 'destination_name': 'str', 'flow_file_availability': 'str', 'flow_files_in': 'int', 'flow_files_out': 'int', 'flow_files_queued': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'name': 'str', 'output': 'str', 'percent_use_bytes': 'int', 'percent_use_count': 'int', 'predictions': 'ConnectionStatusPredictionsSnapshotDTO', 'queued': 'str', 'queued_count': 'str', 'queued_size': 'str', 'source_id': 'str', 'source_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connection_status_snapshot_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connection_status_snapshot_entity.ConnectionStatusSnapshotEntity(id=None, connection_status_snapshot=None, can_read=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'connection_status_snapshot': 'connectionStatusSnapshot', 'id': 'id'}

can_read

Gets the can_read of this ConnectionStatusSnapshotEntity. Indicates whether the user can read a given resource.

Returns:The can_read of this ConnectionStatusSnapshotEntity. Return type:bool

connection_status_snapshot

Gets the connection_status_snapshot of this ConnectionStatusSnapshotEntity.

Returns:The connection_status_snapshot of this ConnectionStatusSnapshotEntity. Return type:ConnectionStatusSnapshotDTO

id

Gets the id of this ConnectionStatusSnapshotEntity. The id of the connection.

Returns:The id of this ConnectionStatusSnapshotEntity. Return type:str

swagger_types = {'can_read': 'bool', 'connection_status_snapshot': 'ConnectionStatusSnapshotDTO', 'id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.connections_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.connections_entity.ConnectionsEntity(connections=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ConnectionsEntity - a model defined in Swagger

attribute_map = {'connections': 'connections'}

connections

Gets the connections of this ConnectionsEntity.

Returns:The connections of this ConnectionsEntity. Return type:list[ConnectionEntity]

swagger_types = {'connections': 'list[ConnectionEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_bulletins_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_bulletins_entity.ControllerBulletinsEntity(bulletins=None, controller_service_bulletins=None, reporting_task_bulletins=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerBulletinsEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'controller_service_bulletins': 'controllerServiceBulletins', 'reporting_task_bulletins': 'reportingTaskBulletins'}

bulletins

Gets the bulletins of this ControllerBulletinsEntity. System level bulletins to be reported to the user.

Returns:The bulletins of this ControllerBulletinsEntity. Return type:list[BulletinEntity]

controller_service_bulletins

Gets the controller_service_bulletins of this ControllerBulletinsEntity. Controller service bulletins to be reported to the user.

Returns:The controller_service_bulletins of this ControllerBulletinsEntity. Return type:list[BulletinEntity]

reporting_task_bulletins

Gets the reporting_task_bulletins of this ControllerBulletinsEntity. Reporting task bulletins to be reported to the user.

Returns:The reporting_task_bulletins of this ControllerBulletinsEntity. Return type:list[BulletinEntity]

swagger_types = {'bulletins': 'list[BulletinEntity]', 'controller_service_bulletins': 'list[BulletinEntity]', 'reporting_task_bulletins': 'list[BulletinEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_configuration_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_configuration_dto.ControllerConfigurationDTO(max_timer_driven_thread_count=None, max_event_driven_thread_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerConfigurationDTO - a model defined in Swagger

attribute_map = {'max_event_driven_thread_count': 'maxEventDrivenThreadCount', 'max_timer_driven_thread_count': 'maxTimerDrivenThreadCount'}

max_event_driven_thread_count

Gets the max_event_driven_thread_count of this ControllerConfigurationDTO. The maximum number of event driven threads the NiFi has available.

Returns:The max_event_driven_thread_count of this ControllerConfigurationDTO. Return type:int

max_timer_driven_thread_count

Gets the max_timer_driven_thread_count of this ControllerConfigurationDTO. The maximum number of timer driven threads the NiFi has available.

Returns:The max_timer_driven_thread_count of this ControllerConfigurationDTO. Return type:int

swagger_types = {'max_event_driven_thread_count': 'int', 'max_timer_driven_thread_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_configuration_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_configuration_entity.ControllerConfigurationEntity(revision=None, permissions=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerConfigurationEntity - a model defined in Swagger

attribute_map = {'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'permissions': 'permissions', 'revision': 'revision'}

component

Gets the component of this ControllerConfigurationEntity. The controller configuration.

Returns:The component of this ControllerConfigurationEntity. Return type:ControllerConfigurationDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ControllerConfigurationEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ControllerConfigurationEntity. Return type:bool

permissions

Gets the permissions of this ControllerConfigurationEntity. The permissions for this component.

Returns:The permissions of this ControllerConfigurationEntity. Return type:PermissionsDTO

revision

Gets the revision of this ControllerConfigurationEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ControllerConfigurationEntity. Return type:RevisionDTO

swagger_types = {'component': 'ControllerConfigurationDTO', 'disconnected_node_acknowledged': 'bool', 'permissions': 'PermissionsDTO', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_dto.ControllerDTO(id=None, name=None, comments=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, input_port_count=None, output_port_count=None, remote_site_listening_port=None, remote_site_http_listening_port=None, site_to_site_secure=None, instance_id=None, input_ports=None, output_ports=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerDTO - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ControllerDTO. The number of active remote ports contained in the NiFi.

Returns:The active_remote_port_count of this ControllerDTO. Return type:int

attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'comments': 'comments', 'disabled_count': 'disabledCount', 'id': 'id', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'input_port_count': 'inputPortCount', 'input_ports': 'inputPorts', 'instance_id': 'instanceId', 'invalid_count': 'invalidCount', 'name': 'name', 'output_port_count': 'outputPortCount', 'output_ports': 'outputPorts', 'remote_site_http_listening_port': 'remoteSiteHttpListeningPort', 'remote_site_listening_port': 'remoteSiteListeningPort', 'running_count': 'runningCount', 'site_to_site_secure': 'siteToSiteSecure', 'stopped_count': 'stoppedCount'}

comments

Gets the comments of this ControllerDTO. The comments for the NiFi.

Returns:The comments of this ControllerDTO. Return type:str

disabled_count

Gets the disabled_count of this ControllerDTO. The number of disabled components in the NiFi.

Returns:The disabled_count of this ControllerDTO. Return type:int

id

Gets the id of this ControllerDTO. The id of the NiFi.

Returns:The id of this ControllerDTO. Return type:str

inactive_remote_port_count

Gets the inactive_remote_port_count of this ControllerDTO. The number of inactive remote ports contained in the NiFi.

Returns:The inactive_remote_port_count of this ControllerDTO. Return type:int

input_port_count

Gets the input_port_count of this ControllerDTO. The number of input ports contained in the NiFi.

Returns:The input_port_count of this ControllerDTO. Return type:int

input_ports

Gets the input_ports of this ControllerDTO. The input ports available to send data to for the NiFi.

Returns:The input_ports of this ControllerDTO. Return type:list[PortDTO]

instance_id

Gets the instance_id of this ControllerDTO. If clustered, the id of the Cluster Manager, otherwise the id of the NiFi.

Returns:The instance_id of this ControllerDTO. Return type:str

invalid_count

Gets the invalid_count of this ControllerDTO. The number of invalid components in the NiFi.

Returns:The invalid_count of this ControllerDTO. Return type:int

name

Gets the name of this ControllerDTO. The name of the NiFi.

Returns:The name of this ControllerDTO. Return type:str

output_port_count

Gets the output_port_count of this ControllerDTO. The number of output ports in the NiFi.

Returns:The output_port_count of this ControllerDTO. Return type:int

output_ports

Gets the output_ports of this ControllerDTO. The output ports available to received data from the NiFi.

Returns:The output_ports of this ControllerDTO. Return type:list[PortDTO]

remote_site_http_listening_port

Gets the remote_site_http_listening_port of this ControllerDTO. The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.

Returns:The remote_site_http_listening_port of this ControllerDTO. Return type:int

remote_site_listening_port

Gets the remote_site_listening_port of this ControllerDTO. The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.

Returns:The remote_site_listening_port of this ControllerDTO. Return type:int

running_count

Gets the running_count of this ControllerDTO. The number of running components in the NiFi.

Returns:The running_count of this ControllerDTO. Return type:int

site_to_site_secure

Gets the site_to_site_secure of this ControllerDTO. Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication).

Returns:The site_to_site_secure of this ControllerDTO. Return type:bool

stopped_count

Gets the stopped_count of this ControllerDTO. The number of stopped components in the NiFi.

Returns:The stopped_count of this ControllerDTO. Return type:int

swagger_types = {'active_remote_port_count': 'int', 'comments': 'str', 'disabled_count': 'int', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'input_ports': 'list[PortDTO]', 'instance_id': 'str', 'invalid_count': 'int', 'name': 'str', 'output_port_count': 'int', 'output_ports': 'list[PortDTO]', 'remote_site_http_listening_port': 'int', 'remote_site_listening_port': 'int', 'running_count': 'int', 'site_to_site_secure': 'bool', 'stopped_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_entity.ControllerEntity(controller=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerEntity - a model defined in Swagger

attribute_map = {'controller': 'controller'}

controller

Gets the controller of this ControllerEntity.

Returns:The controller of this ControllerEntity. Return type:ControllerDTO

swagger_types = {'controller': 'ControllerDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_service_api module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_api.ControllerServiceAPI(type=None, bundle=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceAPI - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'type': 'type'}

bundle

Gets the bundle of this ControllerServiceAPI. The details of the artifact that bundled this service interface.

Returns:The bundle of this ControllerServiceAPI. Return type:Bundle

swagger_types = {'bundle': 'Bundle', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceAPI. The fully qualified name of the service interface.

Returns:The type of this ControllerServiceAPI. Return type:str

nipyapi.nifi.models.controller_service_api_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_api_dto.ControllerServiceApiDTO(type=None, bundle=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceApiDTO - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'type': 'type'}

bundle

Gets the bundle of this ControllerServiceApiDTO. The details of the artifact that bundled this service interface.

Returns:The bundle of this ControllerServiceApiDTO. Return type:BundleDTO

swagger_types = {'bundle': 'BundleDTO', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceApiDTO. The fully qualified name of the service interface.

Returns:The type of this ControllerServiceApiDTO. Return type:str

nipyapi.nifi.models.controller_service_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_dto.ControllerServiceDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, controller_service_apis=None, comments=None, state=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, supports_sensitive_dynamic_properties=None, properties=None, descriptors=None, sensitive_dynamic_property_names=None, custom_ui_url=None, annotation_data=None, referencing_components=None, validation_errors=None, validation_status=None, bulletin_level=None, extension_missing=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceDTO - a model defined in Swagger

annotation_data

Gets the annotation_data of this ControllerServiceDTO. The annotation for the controller service. This is how the custom UI relays configuration to the controller service.

Returns:The annotation_data of this ControllerServiceDTO. Return type:str

attribute_map = {'annotation_data': 'annotationData', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'controller_service_apis': 'controllerServiceApis', 'custom_ui_url': 'customUiUrl', 'deprecated': 'deprecated', 'descriptors': 'descriptors', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'properties': 'properties', 'referencing_components': 'referencingComponents', 'restricted': 'restricted', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'state': 'state', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

bulletin_level

Gets the bulletin_level of this ControllerServiceDTO. The level at which the controller service will report bulletins.

Returns:The bulletin_level of this ControllerServiceDTO. Return type:str

bundle

Gets the bundle of this ControllerServiceDTO. The details of the artifact that bundled this processor type.

Returns:The bundle of this ControllerServiceDTO. Return type:BundleDTO

comments

Gets the comments of this ControllerServiceDTO. The comments for the controller service.

Returns:The comments of this ControllerServiceDTO. Return type:str

controller_service_apis

Gets the controller_service_apis of this ControllerServiceDTO. Lists the APIs this Controller Service implements.

Returns:The controller_service_apis of this ControllerServiceDTO. Return type:list[ControllerServiceApiDTO]

custom_ui_url

Gets the custom_ui_url of this ControllerServiceDTO. The URL for the controller services custom configuration UI if applicable.

Returns:The custom_ui_url of this ControllerServiceDTO. Return type:str

deprecated

Gets the deprecated of this ControllerServiceDTO. Whether the ontroller service has been deprecated.

Returns:The deprecated of this ControllerServiceDTO. Return type:bool

descriptors

Gets the descriptors of this ControllerServiceDTO. The descriptors for the controller service properties.

Returns:The descriptors of this ControllerServiceDTO. Return type:dict(str, PropertyDescriptorDTO)

extension_missing

Gets the extension_missing of this ControllerServiceDTO. Whether the underlying extension is missing.

Returns:The extension_missing of this ControllerServiceDTO. Return type:bool

id

Gets the id of this ControllerServiceDTO. The id of the component.

Returns:The id of this ControllerServiceDTO. Return type:str

multiple_versions_available

Gets the multiple_versions_available of this ControllerServiceDTO. Whether the controller service has multiple versions available.

Returns:The multiple_versions_available of this ControllerServiceDTO. Return type:bool

name

Gets the name of this ControllerServiceDTO. The name of the controller service.

Returns:The name of this ControllerServiceDTO. Return type:str

parent_group_id

Gets the parent_group_id of this ControllerServiceDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this ControllerServiceDTO. Return type:str

persists_state

Gets the persists_state of this ControllerServiceDTO. Whether the controller service persists state.

Returns:The persists_state of this ControllerServiceDTO. Return type:bool

position

Gets the position of this ControllerServiceDTO. The position of this component in the UI if applicable.

Returns:The position of this ControllerServiceDTO. Return type:PositionDTO

properties

Gets the properties of this ControllerServiceDTO. The properties of the controller service.

Returns:The properties of this ControllerServiceDTO. Return type:dict(str, str)

referencing_components

Gets the referencing_components of this ControllerServiceDTO. All components referencing this controller service.

Returns:The referencing_components of this ControllerServiceDTO. Return type:list[ControllerServiceReferencingComponentEntity]

restricted

Gets the restricted of this ControllerServiceDTO. Whether the controller service requires elevated privileges.

Returns:The restricted of this ControllerServiceDTO. Return type:bool

sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ControllerServiceDTO. Set of sensitive dynamic property names

Returns:The sensitive_dynamic_property_names of this ControllerServiceDTO. Return type:list[str]

state

Gets the state of this ControllerServiceDTO. The state of the controller service.

Returns:The state of this ControllerServiceDTO. Return type:str

supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. Whether the controller service supports sensitive dynamic properties.

Returns:The supports_sensitive_dynamic_properties of this ControllerServiceDTO. Return type:bool

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'BundleDTO', 'comments': 'str', 'controller_service_apis': 'list[ControllerServiceApiDTO]', 'custom_ui_url': 'str', 'deprecated': 'bool', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'extension_missing': 'bool', 'id': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'properties': 'dict(str, str)', 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', 'restricted': 'bool', 'sensitive_dynamic_property_names': 'list[str]', 'state': 'str', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceDTO. The type of the controller service.

Returns:The type of this ControllerServiceDTO. Return type:str

validation_errors

Gets the validation_errors of this ControllerServiceDTO. The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.

Returns:The validation_errors of this ControllerServiceDTO. Return type:list[str]

validation_status

Gets the validation_status of this ControllerServiceDTO. Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)

Returns:The validation_status of this ControllerServiceDTO. Return type:str

versioned_component_id

Gets the versioned_component_id of this ControllerServiceDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this ControllerServiceDTO. Return type:str

nipyapi.nifi.models.controller_service_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_entity.ControllerServiceEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, parent_group_id=None, component=None, operate_permissions=None, status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'parent_group_id': 'parentGroupId', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}

bulletins

Gets the bulletins of this ControllerServiceEntity. The bulletins for this component.

Returns:The bulletins of this ControllerServiceEntity. Return type:list[BulletinEntity]

component

Gets the component of this ControllerServiceEntity.

Returns:The component of this ControllerServiceEntity. Return type:ControllerServiceDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ControllerServiceEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ControllerServiceEntity. Return type:bool

id

Gets the id of this ControllerServiceEntity. The id of the component.

Returns:The id of this ControllerServiceEntity. Return type:str

operate_permissions

Gets the operate_permissions of this ControllerServiceEntity. The permissions for this component operations.

Returns:The operate_permissions of this ControllerServiceEntity. Return type:PermissionsDTO

parent_group_id

Gets the parent_group_id of this ControllerServiceEntity. The id of parent process group of this ControllerService.

Returns:The parent_group_id of this ControllerServiceEntity. Return type:str

permissions

Gets the permissions of this ControllerServiceEntity. The permissions for this component.

Returns:The permissions of this ControllerServiceEntity. Return type:PermissionsDTO

position

Gets the position of this ControllerServiceEntity. The position of this component in the UI if applicable.

Returns:The position of this ControllerServiceEntity. Return type:PositionDTO

revision

Gets the revision of this ControllerServiceEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ControllerServiceEntity. Return type:RevisionDTO

status

Gets the status of this ControllerServiceEntity. The status for this ControllerService.

Returns:The status of this ControllerServiceEntity. Return type:ControllerServiceStatusDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ControllerServiceDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'parent_group_id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'ControllerServiceStatusDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ControllerServiceEntity. The URI for futures requests to the component.

Returns:The uri of this ControllerServiceEntity. Return type:str

nipyapi.nifi.models.controller_service_referencing_component_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_referencing_component_dto.ControllerServiceReferencingComponentDTO(group_id=None, id=None, name=None, type=None, state=None, properties=None, descriptors=None, validation_errors=None, reference_type=None, active_thread_count=None, reference_cycle=None, referencing_components=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceReferencingComponentDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ControllerServiceReferencingComponentDTO. The number of active threads for the referencing component.

Returns:The active_thread_count of this ControllerServiceReferencingComponentDTO. Return type:int

attribute_map = {'active_thread_count': 'activeThreadCount', 'descriptors': 'descriptors', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'properties': 'properties', 'reference_cycle': 'referenceCycle', 'reference_type': 'referenceType', 'referencing_components': 'referencingComponents', 'state': 'state', 'type': 'type', 'validation_errors': 'validationErrors'}

descriptors

Gets the descriptors of this ControllerServiceReferencingComponentDTO. The descriptors for the component properties.

Returns:The descriptors of this ControllerServiceReferencingComponentDTO. Return type:dict(str, PropertyDescriptorDTO)

group_id

Gets the group_id of this ControllerServiceReferencingComponentDTO. The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank.

Returns:The group_id of this ControllerServiceReferencingComponentDTO. Return type:str

id

Gets the id of this ControllerServiceReferencingComponentDTO. The id of the component referencing a controller service.

Returns:The id of this ControllerServiceReferencingComponentDTO. Return type:str

name

Gets the name of this ControllerServiceReferencingComponentDTO. The name of the component referencing a controller service.

Returns:The name of this ControllerServiceReferencingComponentDTO. Return type:str

properties

Gets the properties of this ControllerServiceReferencingComponentDTO. The properties for the component.

Returns:The properties of this ControllerServiceReferencingComponentDTO. Return type:dict(str, str)

reference_cycle

Gets the reference_cycle of this ControllerServiceReferencingComponentDTO. If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy.

Returns:The reference_cycle of this ControllerServiceReferencingComponentDTO. Return type:bool

reference_type

Gets the reference_type of this ControllerServiceReferencingComponentDTO. The type of reference this is.

Returns:The reference_type of this ControllerServiceReferencingComponentDTO. Return type:str

referencing_components

Gets the referencing_components of this ControllerServiceReferencingComponentDTO. If the referencing component represents a controller service, these are the components that reference it.

Returns:The referencing_components of this ControllerServiceReferencingComponentDTO. Return type:list[ControllerServiceReferencingComponentEntity]

state

Gets the state of this ControllerServiceReferencingComponentDTO. The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.

Returns:The state of this ControllerServiceReferencingComponentDTO. Return type:str

swagger_types = {'active_thread_count': 'int', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'group_id': 'str', 'id': 'str', 'name': 'str', 'properties': 'dict(str, str)', 'reference_cycle': 'bool', 'reference_type': 'str', 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', 'state': 'str', 'type': 'str', 'validation_errors': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this ControllerServiceReferencingComponentDTO. The type of the component referencing a controller service in simple Java class name format without package name.

Returns:The type of this ControllerServiceReferencingComponentDTO. Return type:str

validation_errors

Gets the validation_errors of this ControllerServiceReferencingComponentDTO. The validation errors for the component.

Returns:The validation_errors of this ControllerServiceReferencingComponentDTO. Return type:list[str]

nipyapi.nifi.models.controller_service_referencing_component_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_referencing_component_entity.ControllerServiceReferencingComponentEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, operate_permissions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceReferencingComponentEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this ControllerServiceReferencingComponentEntity. The bulletins for this component.

Returns:The bulletins of this ControllerServiceReferencingComponentEntity. Return type:list[BulletinEntity]

component

Gets the component of this ControllerServiceReferencingComponentEntity.

Returns:The component of this ControllerServiceReferencingComponentEntity. Return type:ControllerServiceReferencingComponentDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this ControllerServiceReferencingComponentEntity. Return type:bool

id

Gets the id of this ControllerServiceReferencingComponentEntity. The id of the component.

Returns:The id of this ControllerServiceReferencingComponentEntity. Return type:str

operate_permissions

Gets the operate_permissions of this ControllerServiceReferencingComponentEntity. The permissions for this component operations.

Returns:The operate_permissions of this ControllerServiceReferencingComponentEntity. Return type:PermissionsDTO

permissions

Gets the permissions of this ControllerServiceReferencingComponentEntity. The permissions for this component.

Returns:The permissions of this ControllerServiceReferencingComponentEntity. Return type:PermissionsDTO

position

Gets the position of this ControllerServiceReferencingComponentEntity. The position of this component in the UI if applicable.

Returns:The position of this ControllerServiceReferencingComponentEntity. Return type:PositionDTO

revision

Gets the revision of this ControllerServiceReferencingComponentEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this ControllerServiceReferencingComponentEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ControllerServiceReferencingComponentDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ControllerServiceReferencingComponentEntity. The URI for futures requests to the component.

Returns:The uri of this ControllerServiceReferencingComponentEntity. Return type:str

nipyapi.nifi.models.controller_service_referencing_components_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_referencing_components_entity.ControllerServiceReferencingComponentsEntity(controller_service_referencing_components=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceReferencingComponentsEntity - a model defined in Swagger

attribute_map = {'controller_service_referencing_components': 'controllerServiceReferencingComponents'}

controller_service_referencing_components

Gets the controller_service_referencing_components of this ControllerServiceReferencingComponentsEntity.

Returns:The controller_service_referencing_components of this ControllerServiceReferencingComponentsEntity. Return type:list[ControllerServiceReferencingComponentEntity]

swagger_types = {'controller_service_referencing_components': 'list[ControllerServiceReferencingComponentEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_service_types_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_service_types_entity.ControllerServiceTypesEntity(controller_service_types=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServiceTypesEntity - a model defined in Swagger

attribute_map = {'controller_service_types': 'controllerServiceTypes'}

controller_service_types

Gets the controller_service_types of this ControllerServiceTypesEntity.

Returns:The controller_service_types of this ControllerServiceTypesEntity. Return type:list[DocumentedTypeDTO]

swagger_types = {'controller_service_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_services_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_services_entity.ControllerServicesEntity(current_time=None, controller_services=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerServicesEntity - a model defined in Swagger

attribute_map = {'controller_services': 'controllerServices', 'current_time': 'currentTime'}

controller_services

Gets the controller_services of this ControllerServicesEntity.

Returns:The controller_services of this ControllerServicesEntity. Return type:list[ControllerServiceEntity]

current_time

Gets the current_time of this ControllerServicesEntity. The current time on the system.

Returns:The current_time of this ControllerServicesEntity. Return type:str

swagger_types = {'controller_services': 'list[ControllerServiceEntity]', 'current_time': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.controller_status_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_status_dto.ControllerStatusDTO(active_thread_count=None, terminated_thread_count=None, queued=None, flow_files_queued=None, bytes_queued=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerStatusDTO - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ControllerStatusDTO. The number of active remote ports in the NiFi.

Returns:The active_remote_port_count of this ControllerStatusDTO. Return type:int

active_thread_count

Gets the active_thread_count of this ControllerStatusDTO. The number of active threads in the NiFi.

Returns:The active_thread_count of this ControllerStatusDTO. Return type:int

attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'active_thread_count': 'activeThreadCount', 'bytes_queued': 'bytesQueued', 'disabled_count': 'disabledCount', 'flow_files_queued': 'flowFilesQueued', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'invalid_count': 'invalidCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'locally_modified_count': 'locallyModifiedCount', 'queued': 'queued', 'running_count': 'runningCount', 'stale_count': 'staleCount', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'terminated_thread_count': 'terminatedThreadCount', 'up_to_date_count': 'upToDateCount'}

bytes_queued

Gets the bytes_queued of this ControllerStatusDTO. The size of the FlowFiles queued across the entire flow

Returns:The bytes_queued of this ControllerStatusDTO. Return type:int

disabled_count

Gets the disabled_count of this ControllerStatusDTO. The number of disabled components in the NiFi.

Returns:The disabled_count of this ControllerStatusDTO. Return type:int

flow_files_queued

Gets the flow_files_queued of this ControllerStatusDTO. The number of FlowFiles queued across the entire flow

Returns:The flow_files_queued of this ControllerStatusDTO. Return type:int

inactive_remote_port_count

Gets the inactive_remote_port_count of this ControllerStatusDTO. The number of inactive remote ports in the NiFi.

Returns:The inactive_remote_port_count of this ControllerStatusDTO. Return type:int

invalid_count

Gets the invalid_count of this ControllerStatusDTO. The number of invalid components in the NiFi.

Returns:The invalid_count of this ControllerStatusDTO. Return type:int

locally_modified_and_stale_count

Gets the locally_modified_and_stale_count of this ControllerStatusDTO. The number of locally modified and stale versioned process groups in the NiFi.

Returns:The locally_modified_and_stale_count of this ControllerStatusDTO. Return type:int

locally_modified_count

Gets the locally_modified_count of this ControllerStatusDTO. The number of locally modified versioned process groups in the NiFi.

Returns:The locally_modified_count of this ControllerStatusDTO. Return type:int

queued

Gets the queued of this ControllerStatusDTO. The number of flowfiles queued in the NiFi.

Returns:The queued of this ControllerStatusDTO. Return type:str

running_count

Gets the running_count of this ControllerStatusDTO. The number of running components in the NiFi.

Returns:The running_count of this ControllerStatusDTO. Return type:int

stale_count

Gets the stale_count of this ControllerStatusDTO. The number of stale versioned process groups in the NiFi.

Returns:The stale_count of this ControllerStatusDTO. Return type:int

stopped_count

Gets the stopped_count of this ControllerStatusDTO. The number of stopped components in the NiFi.

Returns:The stopped_count of this ControllerStatusDTO. Return type:int

swagger_types = {'active_remote_port_count': 'int', 'active_thread_count': 'int', 'bytes_queued': 'int', 'disabled_count': 'int', 'flow_files_queued': 'int', 'inactive_remote_port_count': 'int', 'invalid_count': 'int', 'locally_modified_and_stale_count': 'int', 'locally_modified_count': 'int', 'queued': 'str', 'running_count': 'int', 'stale_count': 'int', 'stopped_count': 'int', 'sync_failure_count': 'int', 'terminated_thread_count': 'int', 'up_to_date_count': 'int'}

sync_failure_count

Gets the sync_failure_count of this ControllerStatusDTO. The number of versioned process groups in the NiFi that are unable to sync to a registry.

Returns:The sync_failure_count of this ControllerStatusDTO. Return type:int

terminated_thread_count

Gets the terminated_thread_count of this ControllerStatusDTO. The number of terminated threads in the NiFi.

Returns:The terminated_thread_count of this ControllerStatusDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

up_to_date_count

Gets the up_to_date_count of this ControllerStatusDTO. The number of up to date versioned process groups in the NiFi.

Returns:The up_to_date_count of this ControllerStatusDTO. Return type:int

nipyapi.nifi.models.controller_status_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.controller_status_entity.ControllerStatusEntity(controller_status=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ControllerStatusEntity - a model defined in Swagger

attribute_map = {'controller_status': 'controllerStatus'}

controller_status

Gets the controller_status of this ControllerStatusEntity.

Returns:The controller_status of this ControllerStatusEntity. Return type:ControllerStatusDTO

swagger_types = {'controller_status': 'ControllerStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.copy_snippet_request_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.copy_snippet_request_entity.CopySnippetRequestEntity(snippet_id=None, origin_x=None, origin_y=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CopySnippetRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'origin_x': 'originX', 'origin_y': 'originY', 'snippet_id': 'snippetId'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this CopySnippetRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this CopySnippetRequestEntity. Return type:bool

origin_x

Gets the origin_x of this CopySnippetRequestEntity. The x coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_x of this CopySnippetRequestEntity. Return type:float

origin_y

Gets the origin_y of this CopySnippetRequestEntity. The y coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_y of this CopySnippetRequestEntity. Return type:float

snippet_id

Gets the snippet_id of this CopySnippetRequestEntity. The identifier of the snippet.

Returns:The snippet_id of this CopySnippetRequestEntity. Return type:str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'origin_x': 'float', 'origin_y': 'float', 'snippet_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counter_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.counter_dto.CounterDTO(id=None, context=None, name=None, value_count=None, value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CounterDTO - a model defined in Swagger

attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'value': 'value', 'value_count': 'valueCount'}

context

Gets the context of this CounterDTO. The context of the counter.

Returns:The context of this CounterDTO. Return type:str

id

Gets the id of this CounterDTO. The id of the counter.

Returns:The id of this CounterDTO. Return type:str

name

Gets the name of this CounterDTO. The name of the counter.

Returns:The name of this CounterDTO. Return type:str

swagger_types = {'context': 'str', 'id': 'str', 'name': 'str', 'value': 'str', 'value_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

value

Gets the value of this CounterDTO. The value of the counter.

Returns:The value of this CounterDTO. Return type:str

value_count

Gets the value_count of this CounterDTO. The value count.

Returns:The value_count of this CounterDTO. Return type:int

nipyapi.nifi.models.counter_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.counter_entity.CounterEntity(counter=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CounterEntity - a model defined in Swagger

attribute_map = {'counter': 'counter'}

counter

Gets the counter of this CounterEntity.

Returns:The counter of this CounterEntity. Return type:CounterDTO

swagger_types = {'counter': 'CounterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counters_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.counters_dto.CountersDTO(aggregate_snapshot=None, node_snapshots=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CountersDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this CountersDTO. A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.

Returns:The aggregate_snapshot of this CountersDTO. Return type:CountersSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'node_snapshots': 'nodeSnapshots'}

node_snapshots

Gets the node_snapshots of this CountersDTO. A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:The node_snapshots of this CountersDTO. Return type:list[NodeCountersSnapshotDTO]

swagger_types = {'aggregate_snapshot': 'CountersSnapshotDTO', 'node_snapshots': 'list[NodeCountersSnapshotDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counters_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.counters_entity.CountersEntity(counters=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CountersEntity - a model defined in Swagger

attribute_map = {'counters': 'counters'}

counters

Gets the counters of this CountersEntity.

Returns:The counters of this CountersEntity. Return type:CountersDTO

swagger_types = {'counters': 'CountersDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.counters_snapshot_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.counters_snapshot_dto.CountersSnapshotDTO(generated=None, counters=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CountersSnapshotDTO - a model defined in Swagger

attribute_map = {'counters': 'counters', 'generated': 'generated'}

counters

Gets the counters of this CountersSnapshotDTO. All counters in the NiFi.

Returns:The counters of this CountersSnapshotDTO. Return type:list[CounterDTO]

generated

Gets the generated of this CountersSnapshotDTO. The timestamp when the report was generated.

Returns:The generated of this CountersSnapshotDTO. Return type:str

swagger_types = {'counters': 'list[CounterDTO]', 'generated': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.create_active_request_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.create_active_request_entity.CreateActiveRequestEntity(process_group_id=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CreateActiveRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_id': 'processGroupId'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this CreateActiveRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this CreateActiveRequestEntity. Return type:bool

process_group_id

Gets the process_group_id of this CreateActiveRequestEntity. The Process Group ID that this active request will update

Returns:The process_group_id of this CreateActiveRequestEntity. Return type:str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.create_template_request_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.create_template_request_entity.CreateTemplateRequestEntity(name=None, description=None, snippet_id=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CreateTemplateRequestEntity - a model defined in Swagger

attribute_map = {'description': 'description', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'name': 'name', 'snippet_id': 'snippetId'}

description

Gets the description of this CreateTemplateRequestEntity. The description of the template.

Returns:The description of this CreateTemplateRequestEntity. Return type:str

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this CreateTemplateRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this CreateTemplateRequestEntity. Return type:bool

name

Gets the name of this CreateTemplateRequestEntity. The name of the template.

Returns:The name of this CreateTemplateRequestEntity. Return type:str

snippet_id

Gets the snippet_id of this CreateTemplateRequestEntity. The identifier of the snippet.

Returns:The snippet_id of this CreateTemplateRequestEntity. Return type:str

swagger_types = {'description': 'str', 'disconnected_node_acknowledged': 'bool', 'name': 'str', 'snippet_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.current_user_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.current_user_entity.CurrentUserEntity(identity=None, anonymous=None, provenance_permissions=None, counters_permissions=None, tenants_permissions=None, controller_permissions=None, policies_permissions=None, system_permissions=None, parameter_context_permissions=None, restricted_components_permissions=None, component_restriction_permissions=None, can_version_flows=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

CurrentUserEntity - a model defined in Swagger

anonymous

Gets the anonymous of this CurrentUserEntity. Whether the current user is anonymous.

Returns:The anonymous of this CurrentUserEntity. Return type:bool

attribute_map = {'anonymous': 'anonymous', 'can_version_flows': 'canVersionFlows', 'component_restriction_permissions': 'componentRestrictionPermissions', 'controller_permissions': 'controllerPermissions', 'counters_permissions': 'countersPermissions', 'identity': 'identity', 'parameter_context_permissions': 'parameterContextPermissions', 'policies_permissions': 'policiesPermissions', 'provenance_permissions': 'provenancePermissions', 'restricted_components_permissions': 'restrictedComponentsPermissions', 'system_permissions': 'systemPermissions', 'tenants_permissions': 'tenantsPermissions'}

can_version_flows

Gets the can_version_flows of this CurrentUserEntity. Whether the current user can version flows.

Returns:The can_version_flows of this CurrentUserEntity. Return type:bool

component_restriction_permissions

Gets the component_restriction_permissions of this CurrentUserEntity. Permissions for specific component restrictions.

Returns:The component_restriction_permissions of this CurrentUserEntity. Return type:list[ComponentRestrictionPermissionDTO]

controller_permissions

Gets the controller_permissions of this CurrentUserEntity. Permissions for accessing the controller.

Returns:The controller_permissions of this CurrentUserEntity. Return type:PermissionsDTO

counters_permissions

Gets the counters_permissions of this CurrentUserEntity. Permissions for accessing counters.

Returns:The counters_permissions of this CurrentUserEntity. Return type:PermissionsDTO

identity

Gets the identity of this CurrentUserEntity. The user identity being serialized.

Returns:The identity of this CurrentUserEntity. Return type:str

parameter_context_permissions

Gets the parameter_context_permissions of this CurrentUserEntity. Permissions for accessing parameter contexts.

Returns:The parameter_context_permissions of this CurrentUserEntity. Return type:PermissionsDTO

policies_permissions

Gets the policies_permissions of this CurrentUserEntity. Permissions for accessing the policies.

Returns:The policies_permissions of this CurrentUserEntity. Return type:PermissionsDTO

provenance_permissions

Gets the provenance_permissions of this CurrentUserEntity. Permissions for querying provenance.

Returns:The provenance_permissions of this CurrentUserEntity. Return type:PermissionsDTO

restricted_components_permissions

Gets the restricted_components_permissions of this CurrentUserEntity. Permissions for accessing restricted components. Note: the read permission are not used and will always be false.

Returns:The restricted_components_permissions of this CurrentUserEntity. Return type:PermissionsDTO

swagger_types = {'anonymous': 'bool', 'can_version_flows': 'bool', 'component_restriction_permissions': 'list[ComponentRestrictionPermissionDTO]', 'controller_permissions': 'PermissionsDTO', 'counters_permissions': 'PermissionsDTO', 'identity': 'str', 'parameter_context_permissions': 'PermissionsDTO', 'policies_permissions': 'PermissionsDTO', 'provenance_permissions': 'PermissionsDTO', 'restricted_components_permissions': 'PermissionsDTO', 'system_permissions': 'PermissionsDTO', 'tenants_permissions': 'PermissionsDTO'}

system_permissions

Gets the system_permissions of this CurrentUserEntity. Permissions for accessing system.

Returns:The system_permissions of this CurrentUserEntity. Return type:PermissionsDTO

tenants_permissions

Gets the tenants_permissions of this CurrentUserEntity. Permissions for accessing tenants.

Returns:The tenants_permissions of this CurrentUserEntity. Return type:PermissionsDTO

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.difference_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.difference_dto.DifferenceDTO(difference_type=None, difference=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DifferenceDTO - a model defined in Swagger

attribute_map = {'difference': 'difference', 'difference_type': 'differenceType'}

difference

Gets the difference of this DifferenceDTO. Description of the difference

Returns:The difference of this DifferenceDTO. Return type:str

difference_type

Gets the difference_type of this DifferenceDTO. The type of difference

Returns:The difference_type of this DifferenceDTO. Return type:str

swagger_types = {'difference': 'str', 'difference_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.dimensions_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.dimensions_dto.DimensionsDTO(width=None, height=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DimensionsDTO - a model defined in Swagger

attribute_map = {'height': 'height', 'width': 'width'}

height

Gets the height of this DimensionsDTO. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this DimensionsDTO. Return type:float

swagger_types = {'height': 'float', 'width': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

width

Gets the width of this DimensionsDTO. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this DimensionsDTO. Return type:float

nipyapi.nifi.models.documented_type_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.documented_type_dto.DocumentedTypeDTO(type=None, bundle=None, controller_service_apis=None, description=None, restricted=None, usage_restriction=None, explicit_restrictions=None, deprecation_reason=None, tags=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DocumentedTypeDTO - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'controller_service_apis': 'controllerServiceApis', 'deprecation_reason': 'deprecationReason', 'description': 'description', 'explicit_restrictions': 'explicitRestrictions', 'restricted': 'restricted', 'tags': 'tags', 'type': 'type', 'usage_restriction': 'usageRestriction'}

bundle

Gets the bundle of this DocumentedTypeDTO. The details of the artifact that bundled this type.

Returns:The bundle of this DocumentedTypeDTO. Return type:BundleDTO

controller_service_apis

Gets the controller_service_apis of this DocumentedTypeDTO. If this type represents a ControllerService, this lists the APIs it implements.

Returns:The controller_service_apis of this DocumentedTypeDTO. Return type:list[ControllerServiceApiDTO]

deprecation_reason

Gets the deprecation_reason of this DocumentedTypeDTO. The description of why the usage of this component is restricted.

Returns:The deprecation_reason of this DocumentedTypeDTO. Return type:str

description

Gets the description of this DocumentedTypeDTO. The description of the type.

Returns:The description of this DocumentedTypeDTO. Return type:str

explicit_restrictions

Gets the explicit_restrictions of this DocumentedTypeDTO. An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.

Returns:The explicit_restrictions of this DocumentedTypeDTO. Return type:list[ExplicitRestrictionDTO]

restricted

Gets the restricted of this DocumentedTypeDTO. Whether this type is restricted.

Returns:The restricted of this DocumentedTypeDTO. Return type:bool

swagger_types = {'bundle': 'BundleDTO', 'controller_service_apis': 'list[ControllerServiceApiDTO]', 'deprecation_reason': 'str', 'description': 'str', 'explicit_restrictions': 'list[ExplicitRestrictionDTO]', 'restricted': 'bool', 'tags': 'list[str]', 'type': 'str', 'usage_restriction': 'str'}

tags

Gets the tags of this DocumentedTypeDTO. The tags associated with this type.

Returns:The tags of this DocumentedTypeDTO. Return type:list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this DocumentedTypeDTO. The fully qualified name of the type.

Returns:The type of this DocumentedTypeDTO. Return type:str

usage_restriction

Gets the usage_restriction of this DocumentedTypeDTO. The optional description of why the usage of this component is restricted.

Returns:The usage_restriction of this DocumentedTypeDTO. Return type:str

nipyapi.nifi.models.drop_request_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.drop_request_dto.DropRequestDTO(id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, current_count=None, current_size=None, current=None, original_count=None, original_size=None, original=None, dropped_count=None, dropped_size=None, dropped=None, state=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DropRequestDTO - a model defined in Swagger

attribute_map = {'current': 'current', 'current_count': 'currentCount', 'current_size': 'currentSize', 'dropped': 'dropped', 'dropped_count': 'droppedCount', 'dropped_size': 'droppedSize', 'failure_reason': 'failureReason', 'finished': 'finished', 'id': 'id', 'last_updated': 'lastUpdated', 'original': 'original', 'original_count': 'originalCount', 'original_size': 'originalSize', 'percent_completed': 'percentCompleted', 'state': 'state', 'submission_time': 'submissionTime', 'uri': 'uri'}

current

Gets the current of this DropRequestDTO. The count and size of flow files currently queued.

Returns:The current of this DropRequestDTO. Return type:str

current_count

Gets the current_count of this DropRequestDTO. The number of flow files currently queued.

Returns:The current_count of this DropRequestDTO. Return type:int

current_size

Gets the current_size of this DropRequestDTO. The size of flow files currently queued in bytes.

Returns:The current_size of this DropRequestDTO. Return type:int

dropped

Gets the dropped of this DropRequestDTO. The count and size of flow files that have been dropped thus far.

Returns:The dropped of this DropRequestDTO. Return type:str

dropped_count

Gets the dropped_count of this DropRequestDTO. The number of flow files that have been dropped thus far.

Returns:The dropped_count of this DropRequestDTO. Return type:int

dropped_size

Gets the dropped_size of this DropRequestDTO. The size of flow files that have been dropped thus far in bytes.

Returns:The dropped_size of this DropRequestDTO. Return type:int

failure_reason

Gets the failure_reason of this DropRequestDTO. The reason, if any, that this drop request failed.

Returns:The failure_reason of this DropRequestDTO. Return type:str

finished

Gets the finished of this DropRequestDTO. Whether the query has finished.

Returns:The finished of this DropRequestDTO. Return type:bool

id

Gets the id of this DropRequestDTO. The id for this drop request.

Returns:The id of this DropRequestDTO. Return type:str

last_updated

Gets the last_updated of this DropRequestDTO. The last time this drop request was updated.

Returns:The last_updated of this DropRequestDTO. Return type:str

original

Gets the original of this DropRequestDTO. The count and size of flow files to be dropped as a result of this request.

Returns:The original of this DropRequestDTO. Return type:str

original_count

Gets the original_count of this DropRequestDTO. The number of flow files to be dropped as a result of this request.

Returns:The original_count of this DropRequestDTO. Return type:int

original_size

Gets the original_size of this DropRequestDTO. The size of flow files to be dropped as a result of this request in bytes.

Returns:The original_size of this DropRequestDTO. Return type:int

percent_completed

Gets the percent_completed of this DropRequestDTO. The current percent complete.

Returns:The percent_completed of this DropRequestDTO. Return type:int

state

Gets the state of this DropRequestDTO. The current state of the drop request.

Returns:The state of this DropRequestDTO. Return type:str

submission_time

Gets the submission_time of this DropRequestDTO. The timestamp when the query was submitted.

Returns:The submission_time of this DropRequestDTO. Return type:str

swagger_types = {'current': 'str', 'current_count': 'int', 'current_size': 'int', 'dropped': 'str', 'dropped_count': 'int', 'dropped_size': 'int', 'failure_reason': 'str', 'finished': 'bool', 'id': 'str', 'last_updated': 'str', 'original': 'str', 'original_count': 'int', 'original_size': 'int', 'percent_completed': 'int', 'state': 'str', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this DropRequestDTO. The URI for future requests to this drop request.

Returns:The uri of this DropRequestDTO. Return type:str

nipyapi.nifi.models.drop_request_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.drop_request_entity.DropRequestEntity(drop_request=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

DropRequestEntity - a model defined in Swagger

attribute_map = {'drop_request': 'dropRequest'}

drop_request

Gets the drop_request of this DropRequestEntity.

Returns:The drop_request of this DropRequestEntity. Return type:DropRequestDTO

swagger_types = {'drop_request': 'DropRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_breadcrumb_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_breadcrumb_dto.FlowBreadcrumbDTO(id=None, name=None, version_control_information=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowBreadcrumbDTO - a model defined in Swagger

attribute_map = {'id': 'id', 'name': 'name', 'version_control_information': 'versionControlInformation'}

id

Gets the id of this FlowBreadcrumbDTO. The id of the group.

Returns:The id of this FlowBreadcrumbDTO. Return type:str

name

Gets the name of this FlowBreadcrumbDTO. The id of the group.

Returns:The name of this FlowBreadcrumbDTO. Return type:str

swagger_types = {'id': 'str', 'name': 'str', 'version_control_information': 'VersionControlInformationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version_control_information

Gets the version_control_information of this FlowBreadcrumbDTO. The process group version control information or null if not version controlled.

Returns:The version_control_information of this FlowBreadcrumbDTO. Return type:VersionControlInformationDTO

nipyapi.nifi.models.flow_breadcrumb_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_breadcrumb_entity.FlowBreadcrumbEntity(id=None, permissions=None, versioned_flow_state=None, breadcrumb=None, parent_breadcrumb=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowBreadcrumbEntity - a model defined in Swagger

attribute_map = {'breadcrumb': 'breadcrumb', 'id': 'id', 'parent_breadcrumb': 'parentBreadcrumb', 'permissions': 'permissions', 'versioned_flow_state': 'versionedFlowState'}

breadcrumb

Gets the breadcrumb of this FlowBreadcrumbEntity. This breadcrumb.

Returns:The breadcrumb of this FlowBreadcrumbEntity. Return type:FlowBreadcrumbDTO

id

Gets the id of this FlowBreadcrumbEntity. The id of this ancestor ProcessGroup.

Returns:The id of this FlowBreadcrumbEntity. Return type:str

parent_breadcrumb

Gets the parent_breadcrumb of this FlowBreadcrumbEntity. The parent breadcrumb for this breadcrumb.

Returns:The parent_breadcrumb of this FlowBreadcrumbEntity. Return type:FlowBreadcrumbEntity

permissions

Gets the permissions of this FlowBreadcrumbEntity. The permissions for this ancestor ProcessGroup.

Returns:The permissions of this FlowBreadcrumbEntity. Return type:PermissionsDTO

swagger_types = {'breadcrumb': 'FlowBreadcrumbDTO', 'id': 'str', 'parent_breadcrumb': 'FlowBreadcrumbEntity', 'permissions': 'PermissionsDTO', 'versioned_flow_state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_flow_state

Gets the versioned_flow_state of this FlowBreadcrumbEntity. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The versioned_flow_state of this FlowBreadcrumbEntity. Return type:str

nipyapi.nifi.models.flow_comparison_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_comparison_entity.FlowComparisonEntity(component_differences=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowComparisonEntity - a model defined in Swagger

attribute_map = {'component_differences': 'componentDifferences'}

component_differences

Gets the component_differences of this FlowComparisonEntity. The list of differences for each component in the flow that is not the same between the two flows

Returns:The component_differences of this FlowComparisonEntity. Return type:list[ComponentDifferenceDTO]

swagger_types = {'component_differences': 'list[ComponentDifferenceDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_configuration_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_configuration_dto.FlowConfigurationDTO(supports_managed_authorizer=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, auto_refresh_interval_seconds=None, current_time=None, time_offset=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowConfigurationDTO - a model defined in Swagger

attribute_map = {'auto_refresh_interval_seconds': 'autoRefreshIntervalSeconds', 'current_time': 'currentTime', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', 'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups', 'supports_managed_authorizer': 'supportsManagedAuthorizer', 'time_offset': 'timeOffset'}

auto_refresh_interval_seconds

Gets the auto_refresh_interval_seconds of this FlowConfigurationDTO. The interval in seconds between the automatic NiFi refresh requests.

Returns:The auto_refresh_interval_seconds of this FlowConfigurationDTO. Return type:int

current_time

Gets the current_time of this FlowConfigurationDTO. The current time on the system.

Returns:The current_time of this FlowConfigurationDTO. Return type:str

default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this FlowConfigurationDTO. The default back pressure data size threshold.

Returns:The default_back_pressure_data_size_threshold of this FlowConfigurationDTO. Return type:str

default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this FlowConfigurationDTO. The default back pressure object threshold.

Returns:The default_back_pressure_object_threshold of this FlowConfigurationDTO. Return type:int

supports_configurable_authorizer

Gets the supports_configurable_authorizer of this FlowConfigurationDTO. Whether this NiFi supports a configurable authorizer.

Returns:The supports_configurable_authorizer of this FlowConfigurationDTO. Return type:bool

supports_configurable_users_and_groups

Gets the supports_configurable_users_and_groups of this FlowConfigurationDTO. Whether this NiFi supports configurable users and groups.

Returns:The supports_configurable_users_and_groups of this FlowConfigurationDTO. Return type:bool

supports_managed_authorizer

Gets the supports_managed_authorizer of this FlowConfigurationDTO. Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.

Returns:The supports_managed_authorizer of this FlowConfigurationDTO. Return type:bool

swagger_types = {'auto_refresh_interval_seconds': 'int', 'current_time': 'str', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'supports_configurable_authorizer': 'bool', 'supports_configurable_users_and_groups': 'bool', 'supports_managed_authorizer': 'bool', 'time_offset': 'int'}

time_offset

Gets the time_offset of this FlowConfigurationDTO. The time offset of the system.

Returns:The time_offset of this FlowConfigurationDTO. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_configuration_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_configuration_entity.FlowConfigurationEntity(flow_configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowConfigurationEntity - a model defined in Swagger

attribute_map = {'flow_configuration': 'flowConfiguration'}

flow_configuration

Gets the flow_configuration of this FlowConfigurationEntity. The controller configuration.

Returns:The flow_configuration of this FlowConfigurationEntity. Return type:FlowConfigurationDTO

swagger_types = {'flow_configuration': 'FlowConfigurationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_dto.FlowDTO(process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowDTO - a model defined in Swagger

attribute_map = {'connections': 'connections', 'funnels': 'funnels', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

connections

Gets the connections of this FlowDTO. The connections in this flow.

Returns:The connections of this FlowDTO. Return type:list[ConnectionEntity]

funnels

Gets the funnels of this FlowDTO. The funnels in this flow.

Returns:The funnels of this FlowDTO. Return type:list[FunnelEntity]

input_ports

Gets the input_ports of this FlowDTO. The input ports in this flow.

Returns:The input_ports of this FlowDTO. Return type:list[PortEntity]

labels

Gets the labels of this FlowDTO. The labels in this flow.

Returns:The labels of this FlowDTO. Return type:list[LabelEntity]

output_ports

Gets the output_ports of this FlowDTO. The output ports in this flow.

Returns:The output_ports of this FlowDTO. Return type:list[PortEntity]

process_groups

Gets the process_groups of this FlowDTO. The process groups in this flow.

Returns:The process_groups of this FlowDTO. Return type:list[ProcessGroupEntity]

processors

Gets the processors of this FlowDTO. The processors in this flow.

Returns:The processors of this FlowDTO. Return type:list[ProcessorEntity]

remote_process_groups

Gets the remote_process_groups of this FlowDTO. The remote process groups in this flow.

Returns:The remote_process_groups of this FlowDTO. Return type:list[RemoteProcessGroupEntity]

swagger_types = {'connections': 'list[ConnectionEntity]', 'funnels': 'list[FunnelEntity]', 'input_ports': 'list[PortEntity]', 'labels': 'list[LabelEntity]', 'output_ports': 'list[PortEntity]', 'process_groups': 'list[ProcessGroupEntity]', 'processors': 'list[ProcessorEntity]', 'remote_process_groups': 'list[RemoteProcessGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_entity.FlowEntity(flow=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowEntity - a model defined in Swagger

attribute_map = {'flow': 'flow'}

flow

Gets the flow of this FlowEntity.

Returns:The flow of this FlowEntity. Return type:FlowDTO

swagger_types = {'flow': 'FlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_file_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_file_dto.FlowFileDTO(uri=None, uuid=None, filename=None, position=None, size=None, queued_duration=None, lineage_duration=None, penalty_expires_in=None, cluster_node_id=None, cluster_node_address=None, attributes=None, content_claim_section=None, content_claim_container=None, content_claim_identifier=None, content_claim_offset=None, content_claim_file_size=None, content_claim_file_size_bytes=None, penalized=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowFileDTO - a model defined in Swagger

attribute_map = {'attributes': 'attributes', 'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'content_claim_container': 'contentClaimContainer', 'content_claim_file_size': 'contentClaimFileSize', 'content_claim_file_size_bytes': 'contentClaimFileSizeBytes', 'content_claim_identifier': 'contentClaimIdentifier', 'content_claim_offset': 'contentClaimOffset', 'content_claim_section': 'contentClaimSection', 'filename': 'filename', 'lineage_duration': 'lineageDuration', 'penalized': 'penalized', 'penalty_expires_in': 'penaltyExpiresIn', 'position': 'position', 'queued_duration': 'queuedDuration', 'size': 'size', 'uri': 'uri', 'uuid': 'uuid'}

attributes

Gets the attributes of this FlowFileDTO. The FlowFile attributes.

Returns:The attributes of this FlowFileDTO. Return type:dict(str, str)

cluster_node_address

Gets the cluster_node_address of this FlowFileDTO. The label for the node where this FlowFile resides.

Returns:The cluster_node_address of this FlowFileDTO. Return type:str

cluster_node_id

Gets the cluster_node_id of this FlowFileDTO. The id of the node where this FlowFile resides.

Returns:The cluster_node_id of this FlowFileDTO. Return type:str

content_claim_container

Gets the content_claim_container of this FlowFileDTO. The container in which the content claim lives.

Returns:The content_claim_container of this FlowFileDTO. Return type:str

content_claim_file_size

Gets the content_claim_file_size of this FlowFileDTO. The file size of the content claim formatted.

Returns:The content_claim_file_size of this FlowFileDTO. Return type:str

content_claim_file_size_bytes

Gets the content_claim_file_size_bytes of this FlowFileDTO. The file size of the content claim in bytes.

Returns:The content_claim_file_size_bytes of this FlowFileDTO. Return type:int

content_claim_identifier

Gets the content_claim_identifier of this FlowFileDTO. The identifier of the content claim.

Returns:The content_claim_identifier of this FlowFileDTO. Return type:str

content_claim_offset

Gets the content_claim_offset of this FlowFileDTO. The offset into the content claim where the flowfile’s content begins.

Returns:The content_claim_offset of this FlowFileDTO. Return type:int

content_claim_section

Gets the content_claim_section of this FlowFileDTO. The section in which the content claim lives.

Returns:The content_claim_section of this FlowFileDTO. Return type:str

filename

Gets the filename of this FlowFileDTO. The FlowFile filename.

Returns:The filename of this FlowFileDTO. Return type:str

lineage_duration

Gets the lineage_duration of this FlowFileDTO. Duration since the FlowFile’s greatest ancestor entered the flow.

Returns:The lineage_duration of this FlowFileDTO. Return type:int

penalized

Gets the penalized of this FlowFileDTO. If the FlowFile is penalized.

Returns:The penalized of this FlowFileDTO. Return type:bool

penalty_expires_in

Gets the penalty_expires_in of this FlowFileDTO. How long in milliseconds until the FlowFile penalty expires.

Returns:The penalty_expires_in of this FlowFileDTO. Return type:int

position

Gets the position of this FlowFileDTO. The FlowFile’s position in the queue.

Returns:The position of this FlowFileDTO. Return type:int

queued_duration

Gets the queued_duration of this FlowFileDTO. How long this FlowFile has been enqueued.

Returns:The queued_duration of this FlowFileDTO. Return type:int

size

Gets the size of this FlowFileDTO. The FlowFile file size.

Returns:The size of this FlowFileDTO. Return type:int

swagger_types = {'attributes': 'dict(str, str)', 'cluster_node_address': 'str', 'cluster_node_id': 'str', 'content_claim_container': 'str', 'content_claim_file_size': 'str', 'content_claim_file_size_bytes': 'int', 'content_claim_identifier': 'str', 'content_claim_offset': 'int', 'content_claim_section': 'str', 'filename': 'str', 'lineage_duration': 'int', 'penalized': 'bool', 'penalty_expires_in': 'int', 'position': 'int', 'queued_duration': 'int', 'size': 'int', 'uri': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this FlowFileDTO. The URI that can be used to access this FlowFile.

Returns:The uri of this FlowFileDTO. Return type:str

uuid

Gets the uuid of this FlowFileDTO. The FlowFile UUID.

Returns:The uuid of this FlowFileDTO. Return type:str

nipyapi.nifi.models.flow_file_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_file_entity.FlowFileEntity(flow_file=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowFileEntity - a model defined in Swagger

attribute_map = {'flow_file': 'flowFile'}

flow_file

Gets the flow_file of this FlowFileEntity.

Returns:The flow_file of this FlowFileEntity. Return type:FlowFileDTO

swagger_types = {'flow_file': 'FlowFileDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.flow_file_summary_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_file_summary_dto.FlowFileSummaryDTO(uri=None, uuid=None, filename=None, position=None, size=None, queued_duration=None, lineage_duration=None, penalty_expires_in=None, cluster_node_id=None, cluster_node_address=None, penalized=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowFileSummaryDTO - a model defined in Swagger

attribute_map = {'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'filename': 'filename', 'lineage_duration': 'lineageDuration', 'penalized': 'penalized', 'penalty_expires_in': 'penaltyExpiresIn', 'position': 'position', 'queued_duration': 'queuedDuration', 'size': 'size', 'uri': 'uri', 'uuid': 'uuid'}

cluster_node_address

Gets the cluster_node_address of this FlowFileSummaryDTO. The label for the node where this FlowFile resides.

Returns:The cluster_node_address of this FlowFileSummaryDTO. Return type:str

cluster_node_id

Gets the cluster_node_id of this FlowFileSummaryDTO. The id of the node where this FlowFile resides.

Returns:The cluster_node_id of this FlowFileSummaryDTO. Return type:str

filename

Gets the filename of this FlowFileSummaryDTO. The FlowFile filename.

Returns:The filename of this FlowFileSummaryDTO. Return type:str

lineage_duration

Gets the lineage_duration of this FlowFileSummaryDTO. Duration since the FlowFile’s greatest ancestor entered the flow.

Returns:The lineage_duration of this FlowFileSummaryDTO. Return type:int

penalized

Gets the penalized of this FlowFileSummaryDTO. If the FlowFile is penalized.

Returns:The penalized of this FlowFileSummaryDTO. Return type:bool

penalty_expires_in

Gets the penalty_expires_in of this FlowFileSummaryDTO. How long in milliseconds until the FlowFile penalty expires.

Returns:The penalty_expires_in of this FlowFileSummaryDTO. Return type:int

position

Gets the position of this FlowFileSummaryDTO. The FlowFile’s position in the queue.

Returns:The position of this FlowFileSummaryDTO. Return type:int

queued_duration

Gets the queued_duration of this FlowFileSummaryDTO. How long this FlowFile has been enqueued.

Returns:The queued_duration of this FlowFileSummaryDTO. Return type:int

size

Gets the size of this FlowFileSummaryDTO. The FlowFile file size.

Returns:The size of this FlowFileSummaryDTO. Return type:int

swagger_types = {'cluster_node_address': 'str', 'cluster_node_id': 'str', 'filename': 'str', 'lineage_duration': 'int', 'penalized': 'bool', 'penalty_expires_in': 'int', 'position': 'int', 'queued_duration': 'int', 'size': 'int', 'uri': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this FlowFileSummaryDTO. The URI that can be used to access this FlowFile.

Returns:The uri of this FlowFileSummaryDTO. Return type:str

uuid

Gets the uuid of this FlowFileSummaryDTO. The FlowFile UUID.

Returns:The uuid of this FlowFileSummaryDTO. Return type:str

nipyapi.nifi.models.flow_snippet_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.flow_snippet_dto.FlowSnippetDTO(process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FlowSnippetDTO - a model defined in Swagger

attribute_map = {'connections': 'connections', 'controller_services': 'controllerServices', 'funnels': 'funnels', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

connections

Gets the connections of this FlowSnippetDTO. The connections in this flow snippet.

Returns:The connections of this FlowSnippetDTO. Return type:list[ConnectionDTO]

controller_services

Gets the controller_services of this FlowSnippetDTO. The controller services in this flow snippet.

Returns:The controller_services of this FlowSnippetDTO. Return type:list[ControllerServiceDTO]

funnels

Gets the funnels of this FlowSnippetDTO. The funnels in this flow snippet.

Returns:The funnels of this FlowSnippetDTO. Return type:list[FunnelDTO]

input_ports

Gets the input_ports of this FlowSnippetDTO. The input ports in this flow snippet.

Returns:The input_ports of this FlowSnippetDTO. Return type:list[PortDTO]

labels

Gets the labels of this FlowSnippetDTO. The labels in this flow snippet.

Returns:The labels of this FlowSnippetDTO. Return type:list[LabelDTO]

output_ports

Gets the output_ports of this FlowSnippetDTO. The output ports in this flow snippet.

Returns:The output_ports of this FlowSnippetDTO. Return type:list[PortDTO]

process_groups

Gets the process_groups of this FlowSnippetDTO. The process groups in this flow snippet.

Returns:The process_groups of this FlowSnippetDTO. Return type:list[ProcessGroupDTO]

processors

Gets the processors of this FlowSnippetDTO. The processors in this flow snippet.

Returns:The processors of this FlowSnippetDTO. Return type:list[ProcessorDTO]

remote_process_groups

Gets the remote_process_groups of this FlowSnippetDTO. The remote process groups in this flow snippet.

Returns:The remote_process_groups of this FlowSnippetDTO. Return type:list[RemoteProcessGroupDTO]

swagger_types = {'connections': 'list[ConnectionDTO]', 'controller_services': 'list[ControllerServiceDTO]', 'funnels': 'list[FunnelDTO]', 'input_ports': 'list[PortDTO]', 'labels': 'list[LabelDTO]', 'output_ports': 'list[PortDTO]', 'process_groups': 'list[ProcessGroupDTO]', 'processors': 'list[ProcessorDTO]', 'remote_process_groups': 'list[RemoteProcessGroupDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.funnel_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.funnel_dto.FunnelDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FunnelDTO - a model defined in Swagger

attribute_map = {'id': 'id', 'parent_group_id': 'parentGroupId', 'position': 'position', 'versioned_component_id': 'versionedComponentId'}

id

Gets the id of this FunnelDTO. The id of the component.

Returns:The id of this FunnelDTO. Return type:str

parent_group_id

Gets the parent_group_id of this FunnelDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this FunnelDTO. Return type:str

position

Gets the position of this FunnelDTO. The position of this component in the UI if applicable.

Returns:The position of this FunnelDTO. Return type:PositionDTO

swagger_types = {'id': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this FunnelDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this FunnelDTO. Return type:str

nipyapi.nifi.models.funnel_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.funnel_entity.FunnelEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FunnelEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this FunnelEntity. The bulletins for this component.

Returns:The bulletins of this FunnelEntity. Return type:list[BulletinEntity]

component

Gets the component of this FunnelEntity.

Returns:The component of this FunnelEntity. Return type:FunnelDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this FunnelEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this FunnelEntity. Return type:bool

id

Gets the id of this FunnelEntity. The id of the component.

Returns:The id of this FunnelEntity. Return type:str

permissions

Gets the permissions of this FunnelEntity. The permissions for this component.

Returns:The permissions of this FunnelEntity. Return type:PermissionsDTO

position

Gets the position of this FunnelEntity. The position of this component in the UI if applicable.

Returns:The position of this FunnelEntity. Return type:PositionDTO

revision

Gets the revision of this FunnelEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this FunnelEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'FunnelDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this FunnelEntity. The URI for futures requests to the component.

Returns:The uri of this FunnelEntity. Return type:str

nipyapi.nifi.models.funnels_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.funnels_entity.FunnelsEntity(funnels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

FunnelsEntity - a model defined in Swagger

attribute_map = {'funnels': 'funnels'}

funnels

Gets the funnels of this FunnelsEntity.

Returns:The funnels of this FunnelsEntity. Return type:list[FunnelEntity]

swagger_types = {'funnels': 'list[FunnelEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.garbage_collection_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.garbage_collection_dto.GarbageCollectionDTO(name=None, collection_count=None, collection_time=None, collection_millis=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

GarbageCollectionDTO - a model defined in Swagger

attribute_map = {'collection_count': 'collectionCount', 'collection_millis': 'collectionMillis', 'collection_time': 'collectionTime', 'name': 'name'}

collection_count

Gets the collection_count of this GarbageCollectionDTO. The number of times garbage collection has run.

Returns:The collection_count of this GarbageCollectionDTO. Return type:int

collection_millis

Gets the collection_millis of this GarbageCollectionDTO. The total number of milliseconds spent garbage collecting.

Returns:The collection_millis of this GarbageCollectionDTO. Return type:int

collection_time

Gets the collection_time of this GarbageCollectionDTO. The total amount of time spent garbage collecting.

Returns:The collection_time of this GarbageCollectionDTO. Return type:str

name

Gets the name of this GarbageCollectionDTO. The name of the garbage collector.

Returns:The name of this GarbageCollectionDTO. Return type:str

swagger_types = {'collection_count': 'int', 'collection_millis': 'int', 'collection_time': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.history_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.history_dto.HistoryDTO(total=None, last_refreshed=None, actions=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

HistoryDTO - a model defined in Swagger

actions

Gets the actions of this HistoryDTO. The actions.

Returns:The actions of this HistoryDTO. Return type:list[ActionEntity]

attribute_map = {'actions': 'actions', 'last_refreshed': 'lastRefreshed', 'total': 'total'}

last_refreshed

Gets the last_refreshed of this HistoryDTO. The timestamp when the report was generated.

Returns:The last_refreshed of this HistoryDTO. Return type:str

swagger_types = {'actions': 'list[ActionEntity]', 'last_refreshed': 'str', 'total': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

total

Gets the total of this HistoryDTO. The number of number of actions that matched the search criteria..

Returns:The total of this HistoryDTO. Return type:int

nipyapi.nifi.models.history_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.history_entity.HistoryEntity(history=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

HistoryEntity - a model defined in Swagger

attribute_map = {'history': 'history'}

history

Gets the history of this HistoryEntity.

Returns:The history of this HistoryEntity. Return type:HistoryDTO

swagger_types = {'history': 'HistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.input_ports_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.input_ports_entity.InputPortsEntity(input_ports=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

InputPortsEntity - a model defined in Swagger

attribute_map = {'input_ports': 'inputPorts'}

input_ports

Gets the input_ports of this InputPortsEntity.

Returns:The input_ports of this InputPortsEntity. Return type:list[PortEntity]

swagger_types = {'input_ports': 'list[PortEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.instantiate_template_request_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.instantiate_template_request_entity.InstantiateTemplateRequestEntity(origin_x=None, origin_y=None, template_id=None, encoding_version=None, snippet=None, disconnected_node_acknowledged=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

InstantiateTemplateRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'encoding_version': 'encodingVersion', 'origin_x': 'originX', 'origin_y': 'originY', 'snippet': 'snippet', 'template_id': 'templateId'}

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this InstantiateTemplateRequestEntity. Return type:bool

encoding_version

Gets the encoding_version of this InstantiateTemplateRequestEntity. The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency.

Returns:The encoding_version of this InstantiateTemplateRequestEntity. Return type:str

origin_x

Gets the origin_x of this InstantiateTemplateRequestEntity. The x coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_x of this InstantiateTemplateRequestEntity. Return type:float

origin_y

Gets the origin_y of this InstantiateTemplateRequestEntity. The y coordinate of the origin of the bounding box where the new components will be placed.

Returns:The origin_y of this InstantiateTemplateRequestEntity. Return type:float

snippet

Gets the snippet of this InstantiateTemplateRequestEntity. A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.

Returns:The snippet of this InstantiateTemplateRequestEntity. Return type:FlowSnippetDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'encoding_version': 'str', 'origin_x': 'float', 'origin_y': 'float', 'snippet': 'FlowSnippetDTO', 'template_id': 'str'}

template_id

Gets the template_id of this InstantiateTemplateRequestEntity. The identifier of the template.

Returns:The template_id of this InstantiateTemplateRequestEntity. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.label_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.label_dto.LabelDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, label=None, width=None, height=None, getz_index=None, style=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LabelDTO - a model defined in Swagger

attribute_map = {'getz_index': 'getzIndex', 'height': 'height', 'id': 'id', 'label': 'label', 'parent_group_id': 'parentGroupId', 'position': 'position', 'style': 'style', 'versioned_component_id': 'versionedComponentId', 'width': 'width'}

getz_index

Gets the getz_index of this LabelDTO. The z index of the label.

Returns:The getz_index of this LabelDTO. Return type:int

height

Gets the height of this LabelDTO. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this LabelDTO. Return type:float

id

Gets the id of this LabelDTO. The id of the component.

Returns:The id of this LabelDTO. Return type:str

label

Gets the label of this LabelDTO. The text that appears in the label.

Returns:The label of this LabelDTO. Return type:str

parent_group_id

Gets the parent_group_id of this LabelDTO. The id of parent process group of this component if applicable.

Returns:The parent_group_id of this LabelDTO. Return type:str

position

Gets the position of this LabelDTO. The position of this component in the UI if applicable.

Returns:The position of this LabelDTO. Return type:PositionDTO

style

Gets the style of this LabelDTO. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:The style of this LabelDTO. Return type:dict(str, str)

swagger_types = {'getz_index': 'int', 'height': 'float', 'id': 'str', 'label': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'style': 'dict(str, str)', 'versioned_component_id': 'str', 'width': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

versioned_component_id

Gets the versioned_component_id of this LabelDTO. The ID of the corresponding component that is under version control

Returns:The versioned_component_id of this LabelDTO. Return type:str

width

Gets the width of this LabelDTO. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this LabelDTO. Return type:float

nipyapi.nifi.models.label_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.label_entity.LabelEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, dimensions=None, getz_index=None, component=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LabelEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'dimensions': 'dimensions', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'getz_index': 'getzIndex', 'id': 'id', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'uri': 'uri'}

bulletins

Gets the bulletins of this LabelEntity. The bulletins for this component.

Returns:The bulletins of this LabelEntity. Return type:list[BulletinEntity]

component

Gets the component of this LabelEntity.

Returns:The component of this LabelEntity. Return type:LabelDTO

dimensions

Gets the dimensions of this LabelEntity.

Returns:The dimensions of this LabelEntity. Return type:DimensionsDTO

disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this LabelEntity. Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Returns:The disconnected_node_acknowledged of this LabelEntity. Return type:bool

getz_index

Gets the getz_index of this LabelEntity. The z index of the label.

Returns:The getz_index of this LabelEntity. Return type:int

id

Gets the id of this LabelEntity. The id of the component.

Returns:The id of this LabelEntity. Return type:str

permissions

Gets the permissions of this LabelEntity. The permissions for this component.

Returns:The permissions of this LabelEntity. Return type:PermissionsDTO

position

Gets the position of this LabelEntity. The position of this component in the UI if applicable.

Returns:The position of this LabelEntity. Return type:PositionDTO

revision

Gets the revision of this LabelEntity. The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.

Returns:The revision of this LabelEntity. Return type:RevisionDTO

swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'LabelDTO', 'dimensions': 'DimensionsDTO', 'disconnected_node_acknowledged': 'bool', 'getz_index': 'int', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this LabelEntity. The URI for futures requests to the component.

Returns:The uri of this LabelEntity. Return type:str

nipyapi.nifi.models.labels_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.labels_entity.LabelsEntity(labels=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LabelsEntity - a model defined in Swagger

attribute_map = {'labels': 'labels'}

labels

Gets the labels of this LabelsEntity.

Returns:The labels of this LabelsEntity. Return type:list[LabelEntity]

swagger_types = {'labels': 'list[LabelEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.lineage_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.lineage_dto.LineageDTO(id=None, uri=None, submission_time=None, expiration=None, percent_completed=None, finished=None, request=None, results=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageDTO - a model defined in Swagger

attribute_map = {'expiration': 'expiration', 'finished': 'finished', 'id': 'id', 'percent_completed': 'percentCompleted', 'request': 'request', 'results': 'results', 'submission_time': 'submissionTime', 'uri': 'uri'}

expiration

Gets the expiration of this LineageDTO. When the lineage query will expire.

Returns:The expiration of this LineageDTO. Return type:str

finished

Gets the finished of this LineageDTO. Whether the lineage query has finished.

Returns:The finished of this LineageDTO. Return type:bool

id

Gets the id of this LineageDTO. The id of this lineage query.

Returns:The id of this LineageDTO. Return type:str

percent_completed

Gets the percent_completed of this LineageDTO. The percent complete for the lineage query.

Returns:The percent_completed of this LineageDTO. Return type:int

request

Gets the request of this LineageDTO. The initial lineage result.

Returns:The request of this LineageDTO. Return type:LineageRequestDTO

results

Gets the results of this LineageDTO. The results of the lineage query.

Returns:The results of this LineageDTO. Return type:LineageResultsDTO

submission_time

Gets the submission_time of this LineageDTO. When the lineage query was submitted.

Returns:The submission_time of this LineageDTO. Return type:str

swagger_types = {'expiration': 'str', 'finished': 'bool', 'id': 'str', 'percent_completed': 'int', 'request': 'LineageRequestDTO', 'results': 'LineageResultsDTO', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this LineageDTO. The URI for this lineage query for later retrieval and deletion.

Returns:The uri of this LineageDTO. Return type:str

nipyapi.nifi.models.lineage_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.lineage_entity.LineageEntity(lineage=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageEntity - a model defined in Swagger

attribute_map = {'lineage': 'lineage'}

lineage

Gets the lineage of this LineageEntity.

Returns:The lineage of this LineageEntity. Return type:LineageDTO

swagger_types = {'lineage': 'LineageDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.lineage_request_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.lineage_request_dto.LineageRequestDTO(event_id=None, lineage_request_type=None, uuid=None, cluster_node_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageRequestDTO - a model defined in Swagger

attribute_map = {'cluster_node_id': 'clusterNodeId', 'event_id': 'eventId', 'lineage_request_type': 'lineageRequestType', 'uuid': 'uuid'}

cluster_node_id

Gets the cluster_node_id of this LineageRequestDTO. The id of the node where this lineage originated if clustered.

Returns:The cluster_node_id of this LineageRequestDTO. Return type:str

event_id

Gets the event_id of this LineageRequestDTO. The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored.

Returns:The event_id of this LineageRequestDTO. Return type:int

lineage_request_type

Gets the lineage_request_type of this LineageRequestDTO. The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.

Returns:The lineage_request_type of this LineageRequestDTO. Return type:str

swagger_types = {'cluster_node_id': 'str', 'event_id': 'int', 'lineage_request_type': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uuid

Gets the uuid of this LineageRequestDTO. The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id.

Returns:The uuid of this LineageRequestDTO. Return type:str

nipyapi.nifi.models.lineage_results_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.lineage_results_dto.LineageResultsDTO(errors=None, nodes=None, links=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

LineageResultsDTO - a model defined in Swagger

attribute_map = {'errors': 'errors', 'links': 'links', 'nodes': 'nodes'}

errors

Gets the errors of this LineageResultsDTO. Any errors that occurred while generating the lineage.

Returns:The errors of this LineageResultsDTO. Return type:list[str]

links

Gets the links of this LineageResultsDTO. The links between the nodes in the lineage.

Returns:The links of this LineageResultsDTO. Return type:list[ProvenanceLinkDTO]

nodes

Gets the nodes of this LineageResultsDTO. The nodes in the lineage.

Returns:The nodes of this LineageResultsDTO. Return type:list[ProvenanceNodeDTO]

swagger_types = {'errors': 'list[str]', 'links': 'list[ProvenanceLinkDTO]', 'nodes': 'list[ProvenanceNodeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.listing_request_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.listing_request_dto.ListingRequestDTO(id=None, uri=None, submission_time=None, last_updated=None, percent_completed=None, finished=None, failure_reason=None, max_results=None, state=None, queue_size=None, flow_file_summaries=None, source_running=None, destination_running=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ListingRequestDTO - a model defined in Swagger

attribute_map = {'destination_running': 'destinationRunning', 'failure_reason': 'failureReason', 'finished': 'finished', 'flow_file_summaries': 'flowFileSummaries', 'id': 'id', 'last_updated': 'lastUpdated', 'max_results': 'maxResults', 'percent_completed': 'percentCompleted', 'queue_size': 'queueSize', 'source_running': 'sourceRunning', 'state': 'state', 'submission_time': 'submissionTime', 'uri': 'uri'}

destination_running

Gets the destination_running of this ListingRequestDTO. Whether the destination of the connection is running

Returns:The destination_running of this ListingRequestDTO. Return type:bool

failure_reason

Gets the failure_reason of this ListingRequestDTO. The reason, if any, that this listing request failed.

Returns:The failure_reason of this ListingRequestDTO. Return type:str

finished

Gets the finished of this ListingRequestDTO. Whether the query has finished.

Returns:The finished of this ListingRequestDTO. Return type:bool

flow_file_summaries

Gets the flow_file_summaries of this ListingRequestDTO. The FlowFile summaries. The summaries will be populated once the request has completed.

Returns:The flow_file_summaries of this ListingRequestDTO. Return type:list[FlowFileSummaryDTO]

id

Gets the id of this ListingRequestDTO. The id for this listing request.

Returns:The id of this ListingRequestDTO. Return type:str

last_updated

Gets the last_updated of this ListingRequestDTO. The last time this listing request was updated.

Returns:The last_updated of this ListingRequestDTO. Return type:str

max_results

Gets the max_results of this ListingRequestDTO. The maximum number of FlowFileSummary objects to return

Returns:The max_results of this ListingRequestDTO. Return type:int

percent_completed

Gets the percent_completed of this ListingRequestDTO. The current percent complete.

Returns:The percent_completed of this ListingRequestDTO. Return type:int

queue_size

Gets the queue_size of this ListingRequestDTO. The size of the queue

Returns:The queue_size of this ListingRequestDTO. Return type:QueueSizeDTO

source_running

Gets the source_running of this ListingRequestDTO. Whether the source of the connection is running

Returns:The source_running of this ListingRequestDTO. Return type:bool

state

Gets the state of this ListingRequestDTO. The current state of the listing request.

Returns:The state of this ListingRequestDTO. Return type:str

submission_time

Gets the submission_time of this ListingRequestDTO. The timestamp when the query was submitted.

Returns:The submission_time of this ListingRequestDTO. Return type:str

swagger_types = {'destination_running': 'bool', 'failure_reason': 'str', 'finished': 'bool', 'flow_file_summaries': 'list[FlowFileSummaryDTO]', 'id': 'str', 'last_updated': 'str', 'max_results': 'int', 'percent_completed': 'int', 'queue_size': 'QueueSizeDTO', 'source_running': 'bool', 'state': 'str', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

uri

Gets the uri of this ListingRequestDTO. The URI for future requests to this listing request.

Returns:The uri of this ListingRequestDTO. Return type:str

nipyapi.nifi.models.listing_request_entity module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.listing_request_entity.ListingRequestEntity(listing_request=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

ListingRequestEntity - a model defined in Swagger

attribute_map = {'listing_request': 'listingRequest'}

listing_request

Gets the listing_request of this ListingRequestEntity.

Returns:The listing_request of this ListingRequestEntity. Return type:ListingRequestDTO

swagger_types = {'listing_request': 'ListingRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_connection_status_snapshot_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.node_connection_status_snapshot_dto.NodeConnectionStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

NodeConnectionStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeConnectionStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeConnectionStatusSnapshotDTO. Return type:str

api_port

Gets the api_port of this NodeConnectionStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeConnectionStatusSnapshotDTO. Return type:int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}

node_id

Gets the node_id of this NodeConnectionStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeConnectionStatusSnapshotDTO. Return type:str

status_snapshot

Gets the status_snapshot of this NodeConnectionStatusSnapshotDTO. The connection status snapshot from the node.

Returns:The status_snapshot of this NodeConnectionStatusSnapshotDTO. Return type:ConnectionStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ConnectionStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.nifi.models.node_counters_snapshot_dto module

NiFi Rest API

The Rest API provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

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

class nipyapi.nifi.models.node_counters_snapshot_dto.NodeCountersSnapshotDTO(node_id=None, address=None, api_port=None, snapshot=None)