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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

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

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.action_details_dto.ActionDetailsDTO[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

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

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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'}
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

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
swagger_types = {'allow_bundle_redeploy': 'bool', 'allow_public_read': 'bool', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'name': 'str', 'permissions': 'Permissions'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

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

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

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

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.component_details_dto.ComponentDetailsDTO[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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', '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
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', 'name': 'str', 'type': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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_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_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_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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.connections_entity.ConnectionsEntity(connections=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.controller_entity.ControllerEntity(controller=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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, properties=None, descriptors=None, custom_ui_url=None, annotation_data=None, referencing_components=None, validation_errors=None, validation_status=None, extension_missing=None)[source]

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', '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', 'state': 'state', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}
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
state

Gets the state of this ControllerServiceDTO. The state of the controller service.

Returns:The state of this ControllerServiceDTO.
Return type:str
swagger_types = {'annotation_data': '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', 'state': 'str', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counter_entity.CounterEntity(counter=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.counters_entity.CountersEntity(counters=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.flow_entity.FlowEntity(flow=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.funnels_entity.FunnelsEntity(funnels=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.history_entity.HistoryEntity(history=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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, style=None)[source]

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 = {'height': 'height', 'id': 'id', 'label': 'label', 'parent_group_id': 'parentGroupId', 'position': 'position', 'style': 'style', 'versioned_component_id': 'versionedComponentId', 'width': 'width'}
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 = {'height': 'float', 'id': 'str', 'label': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'style': 'dict(str, str)', 'versioned_component_id': 'str', 'width': 'float'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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, component=None)[source]

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', '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
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', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.labels_entity.LabelsEntity(labels=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.lineage_entity.LineageEntity(lineage=None)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

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()[source]

Returns the model properties as a dict

to_str()[source]

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.11.1-SNAPSHOT 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)[source]

Bases: object

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

NodeCountersSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeCountersSnapshotDTO. The API address of the node

Returns:The address of this NodeCountersSnapshotDTO.
Return type:str
api_port

Gets the api_port of this NodeCountersSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeCountersSnapshotDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'snapshot': 'snapshot'}
node_id

Gets the node_id of this NodeCountersSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeCountersSnapshotDTO.
Return type:str
snapshot

Gets the snapshot of this NodeCountersSnapshotDTO. The counters from the node.

Returns:The snapshot of this NodeCountersSnapshotDTO.
Return type:CountersSnapshotDTO
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'CountersSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_dto.NodeDTO(node_id=None, address=None, api_port=None, status=None, heartbeat=None, connection_requested=None, roles=None, active_thread_count=None, queued=None, events=None, node_start_time=None)[source]

Bases: object

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

NodeDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this NodeDTO. The active threads for the NiFi on the node.

Returns:The active_thread_count of this NodeDTO.
Return type:int
address

Gets the address of this NodeDTO. The node’s host/ip address.

Returns:The address of this NodeDTO.
Return type:str
api_port

Gets the api_port of this NodeDTO. The port the node is listening for API requests.

Returns:The api_port of this NodeDTO.
Return type:int
attribute_map = {'active_thread_count': 'activeThreadCount', 'address': 'address', 'api_port': 'apiPort', 'connection_requested': 'connectionRequested', 'events': 'events', 'heartbeat': 'heartbeat', 'node_id': 'nodeId', 'node_start_time': 'nodeStartTime', 'queued': 'queued', 'roles': 'roles', 'status': 'status'}
connection_requested

Gets the connection_requested of this NodeDTO. The time of the node’s last connection request.

Returns:The connection_requested of this NodeDTO.
Return type:str
events

Gets the events of this NodeDTO. The node’s events.

Returns:The events of this NodeDTO.
Return type:list[NodeEventDTO]
heartbeat

Gets the heartbeat of this NodeDTO. the time of the nodes’s last heartbeat.

Returns:The heartbeat of this NodeDTO.
Return type:str
node_id

Gets the node_id of this NodeDTO. The id of the node.

Returns:The node_id of this NodeDTO.
Return type:str
node_start_time

Gets the node_start_time of this NodeDTO. The time at which this Node was last refreshed.

Returns:The node_start_time of this NodeDTO.
Return type:str
queued

Gets the queued of this NodeDTO. The queue the NiFi on the node.

Returns:The queued of this NodeDTO.
Return type:str
roles

Gets the roles of this NodeDTO. The roles of this node.

Returns:The roles of this NodeDTO.
Return type:list[str]
status

Gets the status of this NodeDTO. The node’s status.

Returns:The status of this NodeDTO.
Return type:str
swagger_types = {'active_thread_count': 'int', 'address': 'str', 'api_port': 'int', 'connection_requested': 'str', 'events': 'list[NodeEventDTO]', 'heartbeat': 'str', 'node_id': 'str', 'node_start_time': 'str', 'queued': 'str', 'roles': 'list[str]', 'status': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_entity.NodeEntity(node=None)[source]

Bases: object

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

NodeEntity - a model defined in Swagger

attribute_map = {'node': 'node'}
node

Gets the node of this NodeEntity.

Returns:The node of this NodeEntity.
Return type:NodeDTO
swagger_types = {'node': 'NodeDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_event_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_event_dto.NodeEventDTO(timestamp=None, category=None, message=None)[source]

Bases: object

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

NodeEventDTO - a model defined in Swagger

attribute_map = {'category': 'category', 'message': 'message', 'timestamp': 'timestamp'}
category

Gets the category of this NodeEventDTO. The category of the node event.

Returns:The category of this NodeEventDTO.
Return type:str
message

Gets the message of this NodeEventDTO. The message in the node event.

Returns:The message of this NodeEventDTO.
Return type:str
swagger_types = {'category': 'str', 'message': 'str', 'timestamp': 'str'}
timestamp

Gets the timestamp of this NodeEventDTO. The timestamp of the node event.

Returns:The timestamp of this NodeEventDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_port_status_snapshot_dto.NodePortStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)[source]

Bases: object

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

NodePortStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodePortStatusSnapshotDTO. The API address of the node

Returns:The address of this NodePortStatusSnapshotDTO.
Return type:str
api_port

Gets the api_port of this NodePortStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodePortStatusSnapshotDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}
node_id

Gets the node_id of this NodePortStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodePortStatusSnapshotDTO.
Return type:str
status_snapshot

Gets the status_snapshot of this NodePortStatusSnapshotDTO. The port status snapshot from the node.

Returns:The status_snapshot of this NodePortStatusSnapshotDTO.
Return type:PortStatusSnapshotDTO
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'PortStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_process_group_status_snapshot_dto.NodeProcessGroupStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)[source]

Bases: object

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

NodeProcessGroupStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeProcessGroupStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeProcessGroupStatusSnapshotDTO.
Return type:str
api_port

Gets the api_port of this NodeProcessGroupStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeProcessGroupStatusSnapshotDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}
node_id

Gets the node_id of this NodeProcessGroupStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeProcessGroupStatusSnapshotDTO.
Return type:str
status_snapshot

Gets the status_snapshot of this NodeProcessGroupStatusSnapshotDTO. The process group status snapshot from the node.

Returns:The status_snapshot of this NodeProcessGroupStatusSnapshotDTO.
Return type:ProcessGroupStatusSnapshotDTO
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ProcessGroupStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_processor_status_snapshot_dto.NodeProcessorStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)[source]

Bases: object

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

NodeProcessorStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeProcessorStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeProcessorStatusSnapshotDTO.
Return type:str
api_port

Gets the api_port of this NodeProcessorStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeProcessorStatusSnapshotDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}
node_id

Gets the node_id of this NodeProcessorStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeProcessorStatusSnapshotDTO.
Return type:str
status_snapshot

Gets the status_snapshot of this NodeProcessorStatusSnapshotDTO. The processor status snapshot from the node.

Returns:The status_snapshot of this NodeProcessorStatusSnapshotDTO.
Return type:ProcessorStatusSnapshotDTO
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ProcessorStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_remote_process_group_status_snapshot_dto.NodeRemoteProcessGroupStatusSnapshotDTO(node_id=None, address=None, api_port=None, status_snapshot=None)[source]

Bases: object

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

NodeRemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeRemoteProcessGroupStatusSnapshotDTO. The API address of the node

Returns:The address of this NodeRemoteProcessGroupStatusSnapshotDTO.
Return type:str
api_port

Gets the api_port of this NodeRemoteProcessGroupStatusSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeRemoteProcessGroupStatusSnapshotDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshot': 'statusSnapshot'}
node_id

Gets the node_id of this NodeRemoteProcessGroupStatusSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeRemoteProcessGroupStatusSnapshotDTO.
Return type:str
status_snapshot

Gets the status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO. The remote process group status snapshot from the node.

Returns:The status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO.
Return type:RemoteProcessGroupStatusSnapshotDTO
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_search_result_dto.NodeSearchResultDTO(id=None, address=None)[source]

Bases: object

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

NodeSearchResultDTO - a model defined in Swagger

address

Gets the address of this NodeSearchResultDTO. The address of the node that matched the search.

Returns:The address of this NodeSearchResultDTO.
Return type:str
attribute_map = {'address': 'address', 'id': 'id'}
id

Gets the id of this NodeSearchResultDTO. The id of the node that matched the search.

Returns:The id of this NodeSearchResultDTO.
Return type:str
swagger_types = {'address': 'str', 'id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_status_snapshots_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_status_snapshots_dto.NodeStatusSnapshotsDTO(node_id=None, address=None, api_port=None, status_snapshots=None)[source]

Bases: object

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

NodeStatusSnapshotsDTO - a model defined in Swagger

address

Gets the address of this NodeStatusSnapshotsDTO. The node’s host/ip address.

Returns:The address of this NodeStatusSnapshotsDTO.
Return type:str
api_port

Gets the api_port of this NodeStatusSnapshotsDTO. The port the node is listening for API requests.

Returns:The api_port of this NodeStatusSnapshotsDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'status_snapshots': 'statusSnapshots'}
node_id

Gets the node_id of this NodeStatusSnapshotsDTO. The id of the node.

Returns:The node_id of this NodeStatusSnapshotsDTO.
Return type:str
status_snapshots

Gets the status_snapshots of this NodeStatusSnapshotsDTO. A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.

Returns:The status_snapshots of this NodeStatusSnapshotsDTO.
Return type:list[StatusSnapshotDTO]
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshots': 'list[StatusSnapshotDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.node_system_diagnostics_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.node_system_diagnostics_snapshot_dto.NodeSystemDiagnosticsSnapshotDTO(node_id=None, address=None, api_port=None, snapshot=None)[source]

Bases: object

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

NodeSystemDiagnosticsSnapshotDTO - a model defined in Swagger

address

Gets the address of this NodeSystemDiagnosticsSnapshotDTO. The API address of the node

Returns:The address of this NodeSystemDiagnosticsSnapshotDTO.
Return type:str
api_port

Gets the api_port of this NodeSystemDiagnosticsSnapshotDTO. The API port used to communicate with the node

Returns:The api_port of this NodeSystemDiagnosticsSnapshotDTO.
Return type:int
attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'snapshot': 'snapshot'}
node_id

Gets the node_id of this NodeSystemDiagnosticsSnapshotDTO. The unique ID that identifies the node

Returns:The node_id of this NodeSystemDiagnosticsSnapshotDTO.
Return type:str
snapshot

Gets the snapshot of this NodeSystemDiagnosticsSnapshotDTO. The System Diagnostics snapshot from the node.

Returns:The snapshot of this NodeSystemDiagnosticsSnapshotDTO.
Return type:SystemDiagnosticsSnapshotDTO
swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'SystemDiagnosticsSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.output_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.output_ports_entity.OutputPortsEntity(output_ports=None)[source]

Bases: object

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

OutputPortsEntity - a model defined in Swagger

attribute_map = {'output_ports': 'outputPorts'}
output_ports

Gets the output_ports of this OutputPortsEntity.

Returns:The output_ports of this OutputPortsEntity.
Return type:list[PortEntity]
swagger_types = {'output_ports': 'list[PortEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.peer_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.peer_dto.PeerDTO(hostname=None, port=None, secure=None, flow_file_count=None)[source]

Bases: object

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

PeerDTO - a model defined in Swagger

attribute_map = {'flow_file_count': 'flowFileCount', 'hostname': 'hostname', 'port': 'port', 'secure': 'secure'}
flow_file_count

Gets the flow_file_count of this PeerDTO. The number of flowFiles this peer holds.

Returns:The flow_file_count of this PeerDTO.
Return type:int
hostname

Gets the hostname of this PeerDTO. The hostname of this peer.

Returns:The hostname of this PeerDTO.
Return type:str
port

Gets the port of this PeerDTO. The port number of this peer.

Returns:The port of this PeerDTO.
Return type:int
secure

Gets the secure of this PeerDTO. Returns if this peer connection is secure.

Returns:The secure of this PeerDTO.
Return type:bool
swagger_types = {'flow_file_count': 'int', 'hostname': 'str', 'port': 'int', 'secure': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.peers_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.peers_entity.PeersEntity(peers=None)[source]

Bases: object

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

PeersEntity - a model defined in Swagger

attribute_map = {'peers': 'peers'}
peers

Gets the peers of this PeersEntity.

Returns:The peers of this PeersEntity.
Return type:list[PeerDTO]
swagger_types = {'peers': 'list[PeerDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.permissions 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.permissions.Permissions(can_read=None, can_write=None, can_delete=None)[source]

Bases: object

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

Permissions - a model defined in Swagger

attribute_map = {'can_delete': 'canDelete', 'can_read': 'canRead', 'can_write': 'canWrite'}
can_delete

Gets the can_delete of this Permissions. Indicates whether the user can delete a given resource.

Returns:The can_delete of this Permissions.
Return type:bool
can_read

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

Returns:The can_read of this Permissions.
Return type:bool
can_write

Gets the can_write of this Permissions. Indicates whether the user can write a given resource.

Returns:The can_write of this Permissions.
Return type:bool
swagger_types = {'can_delete': 'bool', 'can_read': 'bool', 'can_write': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.permissions_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.permissions_dto.PermissionsDTO(can_read=None, can_write=None)[source]

Bases: object

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

PermissionsDTO - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'can_write': 'canWrite'}
can_read

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

Returns:The can_read of this PermissionsDTO.
Return type:bool
can_write

Gets the can_write of this PermissionsDTO. Indicates whether the user can write a given resource.

Returns:The can_write of this PermissionsDTO.
Return type:bool
swagger_types = {'can_read': 'bool', 'can_write': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_dto.PortDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, state=None, type=None, transmitting=None, concurrently_schedulable_task_count=None, user_access_control=None, group_access_control=None, allow_remote_access=None, validation_errors=None)[source]

Bases: object

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

PortDTO - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this PortDTO. Whether this port can be accessed remotely via Site-to-Site protocol.

Returns:The allow_remote_access of this PortDTO.
Return type:bool
attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'comments': 'comments', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_access_control': 'groupAccessControl', 'id': 'id', 'name': 'name', 'parent_group_id': 'parentGroupId', 'position': 'position', 'state': 'state', 'transmitting': 'transmitting', 'type': 'type', 'user_access_control': 'userAccessControl', 'validation_errors': 'validationErrors', 'versioned_component_id': 'versionedComponentId'}
comments

Gets the comments of this PortDTO. The comments for the port.

Returns:The comments of this PortDTO.
Return type:str
concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this PortDTO. The number of tasks that should be concurrently scheduled for the port.

Returns:The concurrently_schedulable_task_count of this PortDTO.
Return type:int
group_access_control

Gets the group_access_control of this PortDTO. The user groups that are allowed to access the port.

Returns:The group_access_control of this PortDTO.
Return type:list[str]
id

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

Returns:The id of this PortDTO.
Return type:str
name

Gets the name of this PortDTO. The name of the port.

Returns:The name of this PortDTO.
Return type:str
parent_group_id

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

Returns:The parent_group_id of this PortDTO.
Return type:str
position

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

Returns:The position of this PortDTO.
Return type:PositionDTO
state

Gets the state of this PortDTO. The state of the port.

Returns:The state of this PortDTO.
Return type:str
swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'concurrently_schedulable_task_count': 'int', 'group_access_control': 'list[str]', 'id': 'str', 'name': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'state': 'str', 'transmitting': 'bool', 'type': 'str', 'user_access_control': 'list[str]', 'validation_errors': 'list[str]', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmitting

Gets the transmitting of this PortDTO. Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely.

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

Gets the type of this PortDTO. The type of port.

Returns:The type of this PortDTO.
Return type:str
user_access_control

Gets the user_access_control of this PortDTO. The users that are allowed to access the port.

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

Gets the validation_errors of this PortDTO. Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.

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

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

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

nipyapi.nifi.models.port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_entity.PortEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, port_type=None, operate_permissions=None, allow_remote_access=None)[source]

Bases: object

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

PortEntity - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this PortEntity. Whether this port can be accessed remotely via Site-to-Site protocol.

Returns:The allow_remote_access of this PortEntity.
Return type:bool
attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'port_type': 'portType', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}
bulletins

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

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

Gets the component of this PortEntity.

Returns:The component of this PortEntity.
Return type:PortDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this PortEntity.
Return type:bool
id

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

Returns:The id of this PortEntity.
Return type:str
operate_permissions

Gets the operate_permissions of this PortEntity. The permissions for this component operations.

Returns:The operate_permissions of this PortEntity.
Return type:PermissionsDTO
permissions

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

Returns:The permissions of this PortEntity.
Return type:PermissionsDTO
port_type

Gets the port_type of this PortEntity.

Returns:The port_type of this PortEntity.
Return type:str
position

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

Returns:The position of this PortEntity.
Return type:PositionDTO
revision

Gets the revision of this PortEntity. 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 PortEntity.
Return type:RevisionDTO
status

Gets the status of this PortEntity. The status of the port.

Returns:The status of this PortEntity.
Return type:PortStatusDTO
swagger_types = {'allow_remote_access': 'bool', 'bulletins': 'list[BulletinEntity]', 'component': 'PortDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'port_type': 'str', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'PortStatusDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_dto.PortStatusDTO(id=None, group_id=None, name=None, transmitting=None, run_status=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None)[source]

Bases: object

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

PortStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this PortStatusDTO. A status snapshot that represents the aggregate stats 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 PortStatusDTO.
Return type:PortStatusSnapshotDTO
attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'run_status': 'runStatus', 'stats_last_refreshed': 'statsLastRefreshed', 'transmitting': 'transmitting'}
group_id

Gets the group_id of this PortStatusDTO. The id of the parent process group of the port.

Returns:The group_id of this PortStatusDTO.
Return type:str
id

Gets the id of this PortStatusDTO. The id of the port.

Returns:The id of this PortStatusDTO.
Return type:str
name

Gets the name of this PortStatusDTO. The name of the port.

Returns:The name of this PortStatusDTO.
Return type:str
node_snapshots

Gets the node_snapshots of this PortStatusDTO. A status 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 PortStatusDTO.
Return type:list[NodePortStatusSnapshotDTO]
run_status

Gets the run_status of this PortStatusDTO. The run status of the port.

Returns:The run_status of this PortStatusDTO.
Return type:str
stats_last_refreshed

Gets the stats_last_refreshed of this PortStatusDTO. The time the status for the process group was last refreshed.

Returns:The stats_last_refreshed of this PortStatusDTO.
Return type:str
swagger_types = {'aggregate_snapshot': 'PortStatusSnapshotDTO', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodePortStatusSnapshotDTO]', 'run_status': 'str', 'stats_last_refreshed': 'str', 'transmitting': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmitting

Gets the transmitting of this PortStatusDTO. Whether the port has incoming or outgoing connections to a remote NiFi.

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

nipyapi.nifi.models.port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_entity.PortStatusEntity(port_status=None, can_read=None)[source]

Bases: object

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

PortStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'port_status': 'portStatus'}
can_read

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

Returns:The can_read of this PortStatusEntity.
Return type:bool
port_status

Gets the port_status of this PortStatusEntity.

Returns:The port_status of this PortStatusEntity.
Return type:PortStatusDTO
swagger_types = {'can_read': 'bool', 'port_status': 'PortStatusDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_snapshot_dto.PortStatusSnapshotDTO(id=None, group_id=None, name=None, active_thread_count=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, transmitting=None, run_status=None)[source]

Bases: object

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

PortStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this PortStatusSnapshotDTO. The active thread count for the port.

Returns:The active_thread_count of this PortStatusSnapshotDTO.
Return type:int
attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'name': 'name', 'output': 'output', 'run_status': 'runStatus', 'transmitting': 'transmitting'}
bytes_in

Gets the bytes_in of this PortStatusSnapshotDTO. The size of hte FlowFiles that have been accepted in the last 5 minutes.

Returns:The bytes_in of this PortStatusSnapshotDTO.
Return type:int
bytes_out

Gets the bytes_out of this PortStatusSnapshotDTO. The number of bytes that have been processed in the last 5 minutes.

Returns:The bytes_out of this PortStatusSnapshotDTO.
Return type:int
flow_files_in

Gets the flow_files_in of this PortStatusSnapshotDTO. The number of FlowFiles that have been accepted in the last 5 minutes.

Returns:The flow_files_in of this PortStatusSnapshotDTO.
Return type:int
flow_files_out

Gets the flow_files_out of this PortStatusSnapshotDTO. The number of FlowFiles that have been processed in the last 5 minutes.

Returns:The flow_files_out of this PortStatusSnapshotDTO.
Return type:int
group_id

Gets the group_id of this PortStatusSnapshotDTO. The id of the parent process group of the port.

Returns:The group_id of this PortStatusSnapshotDTO.
Return type:str
id

Gets the id of this PortStatusSnapshotDTO. The id of the port.

Returns:The id of this PortStatusSnapshotDTO.
Return type:str
input

Gets the input of this PortStatusSnapshotDTO. The count/size of flowfiles that have been accepted in the last 5 minutes.

Returns:The input of this PortStatusSnapshotDTO.
Return type:str
name

Gets the name of this PortStatusSnapshotDTO. The name of the port.

Returns:The name of this PortStatusSnapshotDTO.
Return type:str
output

Gets the output of this PortStatusSnapshotDTO. The count/size of flowfiles that have been processed in the last 5 minutes.

Returns:The output of this PortStatusSnapshotDTO.
Return type:str
run_status

Gets the run_status of this PortStatusSnapshotDTO. The run status of the port.

Returns:The run_status of this PortStatusSnapshotDTO.
Return type:str
swagger_types = {'active_thread_count': 'int', 'bytes_in': 'int', 'bytes_out': 'int', 'flow_files_in': 'int', 'flow_files_out': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'name': 'str', 'output': 'str', 'run_status': 'str', 'transmitting': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmitting

Gets the transmitting of this PortStatusSnapshotDTO. Whether the port has incoming or outgoing connections to a remote NiFi.

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

nipyapi.nifi.models.port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.port_status_snapshot_entity.PortStatusSnapshotEntity(id=None, port_status_snapshot=None, can_read=None)[source]

Bases: object

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

PortStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'port_status_snapshot': 'portStatusSnapshot'}
can_read

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

Returns:The can_read of this PortStatusSnapshotEntity.
Return type:bool
id

Gets the id of this PortStatusSnapshotEntity. The id of the port.

Returns:The id of this PortStatusSnapshotEntity.
Return type:str
port_status_snapshot

Gets the port_status_snapshot of this PortStatusSnapshotEntity.

Returns:The port_status_snapshot of this PortStatusSnapshotEntity.
Return type:PortStatusSnapshotDTO
swagger_types = {'can_read': 'bool', 'id': 'str', 'port_status_snapshot': 'PortStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.position_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.position_dto.PositionDTO(x=None, y=None)[source]

Bases: object

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

PositionDTO - a model defined in Swagger

attribute_map = {'x': 'x', 'y': 'y'}
swagger_types = {'x': 'float', 'y': 'float'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

x

Gets the x of this PositionDTO. The x coordinate.

Returns:The x of this PositionDTO.
Return type:float
y

Gets the y of this PositionDTO. The y coordinate.

Returns:The y of this PositionDTO.
Return type:float

nipyapi.nifi.models.previous_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.previous_value_dto.PreviousValueDTO(previous_value=None, timestamp=None, user_identity=None)[source]

Bases: object

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

PreviousValueDTO - a model defined in Swagger

attribute_map = {'previous_value': 'previousValue', 'timestamp': 'timestamp', 'user_identity': 'userIdentity'}
previous_value

Gets the previous_value of this PreviousValueDTO. The previous value.

Returns:The previous_value of this PreviousValueDTO.
Return type:str
swagger_types = {'previous_value': 'str', 'timestamp': 'str', 'user_identity': 'str'}
timestamp

Gets the timestamp of this PreviousValueDTO. The timestamp when the value was modified.

Returns:The timestamp of this PreviousValueDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

user_identity

Gets the user_identity of this PreviousValueDTO. The user who changed the previous value.

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

nipyapi.nifi.models.prioritizer_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.prioritizer_types_entity.PrioritizerTypesEntity(prioritizer_types=None)[source]

Bases: object

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

PrioritizerTypesEntity - a model defined in Swagger

attribute_map = {'prioritizer_types': 'prioritizerTypes'}
prioritizer_types

Gets the prioritizer_types of this PrioritizerTypesEntity.

Returns:The prioritizer_types of this PrioritizerTypesEntity.
Return type:list[DocumentedTypeDTO]
swagger_types = {'prioritizer_types': 'list[DocumentedTypeDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_dto.ProcessGroupDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, comments=None, variables=None, version_control_information=None, parameter_context=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, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, contents=None, input_port_count=None, output_port_count=None)[source]

Bases: object

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

ProcessGroupDTO - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ProcessGroupDTO. The number of active remote ports in the process group.

Returns:The active_remote_port_count of this ProcessGroupDTO.
Return type:int
attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'comments': 'comments', 'contents': 'contents', 'disabled_count': 'disabledCount', 'id': 'id', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'input_port_count': 'inputPortCount', 'invalid_count': 'invalidCount', 'local_input_port_count': 'localInputPortCount', 'local_output_port_count': 'localOutputPortCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'locally_modified_count': 'locallyModifiedCount', 'name': 'name', 'output_port_count': 'outputPortCount', 'parameter_context': 'parameterContext', 'parent_group_id': 'parentGroupId', 'position': 'position', 'public_input_port_count': 'publicInputPortCount', 'public_output_port_count': 'publicOutputPortCount', 'running_count': 'runningCount', 'stale_count': 'staleCount', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'up_to_date_count': 'upToDateCount', 'variables': 'variables', 'version_control_information': 'versionControlInformation', 'versioned_component_id': 'versionedComponentId'}
comments

Gets the comments of this ProcessGroupDTO. The comments for the process group.

Returns:The comments of this ProcessGroupDTO.
Return type:str
contents

Gets the contents of this ProcessGroupDTO. The contents of this process group.

Returns:The contents of this ProcessGroupDTO.
Return type:FlowSnippetDTO
disabled_count

Gets the disabled_count of this ProcessGroupDTO. The number of disabled components in the process group.

Returns:The disabled_count of this ProcessGroupDTO.
Return type:int
id

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

Returns:The id of this ProcessGroupDTO.
Return type:str
inactive_remote_port_count

Gets the inactive_remote_port_count of this ProcessGroupDTO. The number of inactive remote ports in the process group.

Returns:The inactive_remote_port_count of this ProcessGroupDTO.
Return type:int
input_port_count

Gets the input_port_count of this ProcessGroupDTO. The number of input ports in the process group.

Returns:The input_port_count of this ProcessGroupDTO.
Return type:int
invalid_count

Gets the invalid_count of this ProcessGroupDTO. The number of invalid components in the process group.

Returns:The invalid_count of this ProcessGroupDTO.
Return type:int
local_input_port_count

Gets the local_input_port_count of this ProcessGroupDTO. The number of local input ports in the process group.

Returns:The local_input_port_count of this ProcessGroupDTO.
Return type:int
local_output_port_count

Gets the local_output_port_count of this ProcessGroupDTO. The number of local output ports in the process group.

Returns:The local_output_port_count of this ProcessGroupDTO.
Return type:int
locally_modified_and_stale_count

Gets the locally_modified_and_stale_count of this ProcessGroupDTO. The number of locally modified and stale versioned process groups in the process group.

Returns:The locally_modified_and_stale_count of this ProcessGroupDTO.
Return type:int
locally_modified_count

Gets the locally_modified_count of this ProcessGroupDTO. The number of locally modified versioned process groups in the process group.

Returns:The locally_modified_count of this ProcessGroupDTO.
Return type:int
name

Gets the name of this ProcessGroupDTO. The name of the process group.

Returns:The name of this ProcessGroupDTO.
Return type:str
output_port_count

Gets the output_port_count of this ProcessGroupDTO. The number of output ports in the process group.

Returns:The output_port_count of this ProcessGroupDTO.
Return type:int
parameter_context

Gets the parameter_context of this ProcessGroupDTO. The Parameter Context that this Process Group is bound to.

Returns:The parameter_context of this ProcessGroupDTO.
Return type:ParameterContextReferenceEntity
parent_group_id

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

Returns:The parent_group_id of this ProcessGroupDTO.
Return type:str
position

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

Returns:The position of this ProcessGroupDTO.
Return type:PositionDTO
public_input_port_count

Gets the public_input_port_count of this ProcessGroupDTO. The number of public input ports in the process group.

Returns:The public_input_port_count of this ProcessGroupDTO.
Return type:int
public_output_port_count

Gets the public_output_port_count of this ProcessGroupDTO. The number of public output ports in the process group.

Returns:The public_output_port_count of this ProcessGroupDTO.
Return type:int
running_count

Gets the running_count of this ProcessGroupDTO. The number of running components in this process group.

Returns:The running_count of this ProcessGroupDTO.
Return type:int
stale_count

Gets the stale_count of this ProcessGroupDTO. The number of stale versioned process groups in the process group.

Returns:The stale_count of this ProcessGroupDTO.
Return type:int
stopped_count

Gets the stopped_count of this ProcessGroupDTO. The number of stopped components in the process group.

Returns:The stopped_count of this ProcessGroupDTO.
Return type:int
swagger_types = {'active_remote_port_count': 'int', 'comments': 'str', 'contents': 'FlowSnippetDTO', 'disabled_count': 'int', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'invalid_count': 'int', 'local_input_port_count': 'int', 'local_output_port_count': 'int', 'locally_modified_and_stale_count': 'int', 'locally_modified_count': 'int', 'name': 'str', 'output_port_count': 'int', 'parameter_context': 'ParameterContextReferenceEntity', 'parent_group_id': 'str', 'position': 'PositionDTO', 'public_input_port_count': 'int', 'public_output_port_count': 'int', 'running_count': 'int', 'stale_count': 'int', 'stopped_count': 'int', 'sync_failure_count': 'int', 'up_to_date_count': 'int', 'variables': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO', 'versioned_component_id': 'str'}
sync_failure_count

Gets the sync_failure_count of this ProcessGroupDTO. The number of versioned process groups in the process group that are unable to sync to a registry.

Returns:The sync_failure_count of this ProcessGroupDTO.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

up_to_date_count

Gets the up_to_date_count of this ProcessGroupDTO. The number of up to date versioned process groups in the process group.

Returns:The up_to_date_count of this ProcessGroupDTO.
Return type:int
variables

Gets the variables of this ProcessGroupDTO. The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.

Returns:The variables of this ProcessGroupDTO.
Return type:dict(str, str)
version_control_information

Gets the version_control_information of this ProcessGroupDTO. The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control

Returns:The version_control_information of this ProcessGroupDTO.
Return type:VersionControlInformationDTO
versioned_component_id

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

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

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_entity.ProcessGroupEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, versioned_flow_snapshot=None, running_count=None, stopped_count=None, invalid_count=None, disabled_count=None, active_remote_port_count=None, inactive_remote_port_count=None, versioned_flow_state=None, up_to_date_count=None, locally_modified_count=None, stale_count=None, locally_modified_and_stale_count=None, sync_failure_count=None, local_input_port_count=None, local_output_port_count=None, public_input_port_count=None, public_output_port_count=None, parameter_context=None, input_port_count=None, output_port_count=None)[source]

Bases: object

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

ProcessGroupEntity - a model defined in Swagger

active_remote_port_count

Gets the active_remote_port_count of this ProcessGroupEntity. The number of active remote ports in the process group.

Returns:The active_remote_port_count of this ProcessGroupEntity.
Return type:int
attribute_map = {'active_remote_port_count': 'activeRemotePortCount', 'bulletins': 'bulletins', 'component': 'component', 'disabled_count': 'disabledCount', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'inactive_remote_port_count': 'inactiveRemotePortCount', 'input_port_count': 'inputPortCount', 'invalid_count': 'invalidCount', 'local_input_port_count': 'localInputPortCount', 'local_output_port_count': 'localOutputPortCount', 'locally_modified_and_stale_count': 'locallyModifiedAndStaleCount', 'locally_modified_count': 'locallyModifiedCount', 'output_port_count': 'outputPortCount', 'parameter_context': 'parameterContext', 'permissions': 'permissions', 'position': 'position', 'public_input_port_count': 'publicInputPortCount', 'public_output_port_count': 'publicOutputPortCount', 'revision': 'revision', 'running_count': 'runningCount', 'stale_count': 'staleCount', 'status': 'status', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'up_to_date_count': 'upToDateCount', 'uri': 'uri', 'versioned_flow_snapshot': 'versionedFlowSnapshot', 'versioned_flow_state': 'versionedFlowState'}
bulletins

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

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

Gets the component of this ProcessGroupEntity.

Returns:The component of this ProcessGroupEntity.
Return type:ProcessGroupDTO
disabled_count

Gets the disabled_count of this ProcessGroupEntity. The number of disabled components in the process group.

Returns:The disabled_count of this ProcessGroupEntity.
Return type:int
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this ProcessGroupEntity.
Return type:bool
id

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

Returns:The id of this ProcessGroupEntity.
Return type:str
inactive_remote_port_count

Gets the inactive_remote_port_count of this ProcessGroupEntity. The number of inactive remote ports in the process group.

Returns:The inactive_remote_port_count of this ProcessGroupEntity.
Return type:int
input_port_count

Gets the input_port_count of this ProcessGroupEntity. The number of input ports in the process group.

Returns:The input_port_count of this ProcessGroupEntity.
Return type:int
invalid_count

Gets the invalid_count of this ProcessGroupEntity. The number of invalid components in the process group.

Returns:The invalid_count of this ProcessGroupEntity.
Return type:int
local_input_port_count

Gets the local_input_port_count of this ProcessGroupEntity. The number of local input ports in the process group.

Returns:The local_input_port_count of this ProcessGroupEntity.
Return type:int
local_output_port_count

Gets the local_output_port_count of this ProcessGroupEntity. The number of local output ports in the process group.

Returns:The local_output_port_count of this ProcessGroupEntity.
Return type:int
locally_modified_and_stale_count

Gets the locally_modified_and_stale_count of this ProcessGroupEntity. The number of locally modified and stale versioned process groups in the process group.

Returns:The locally_modified_and_stale_count of this ProcessGroupEntity.
Return type:int
locally_modified_count

Gets the locally_modified_count of this ProcessGroupEntity. The number of locally modified versioned process groups in the process group.

Returns:The locally_modified_count of this ProcessGroupEntity.
Return type:int
output_port_count

Gets the output_port_count of this ProcessGroupEntity. The number of output ports in the process group.

Returns:The output_port_count of this ProcessGroupEntity.
Return type:int
parameter_context

Gets the parameter_context of this ProcessGroupEntity. The Parameter Context, or null if no Parameter Context has been bound to the Process Group

Returns:The parameter_context of this ProcessGroupEntity.
Return type:ParameterContextReferenceEntity
permissions

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

Returns:The permissions of this ProcessGroupEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this ProcessGroupEntity.
Return type:PositionDTO
public_input_port_count

Gets the public_input_port_count of this ProcessGroupEntity. The number of public input ports in the process group.

Returns:The public_input_port_count of this ProcessGroupEntity.
Return type:int
public_output_port_count

Gets the public_output_port_count of this ProcessGroupEntity. The number of public output ports in the process group.

Returns:The public_output_port_count of this ProcessGroupEntity.
Return type:int
revision

Gets the revision of this ProcessGroupEntity. 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 ProcessGroupEntity.
Return type:RevisionDTO
running_count

Gets the running_count of this ProcessGroupEntity. The number of running components in this process group.

Returns:The running_count of this ProcessGroupEntity.
Return type:int
stale_count

Gets the stale_count of this ProcessGroupEntity. The number of stale versioned process groups in the process group.

Returns:The stale_count of this ProcessGroupEntity.
Return type:int
status

Gets the status of this ProcessGroupEntity. The status of the process group.

Returns:The status of this ProcessGroupEntity.
Return type:ProcessGroupStatusDTO
stopped_count

Gets the stopped_count of this ProcessGroupEntity. The number of stopped components in the process group.

Returns:The stopped_count of this ProcessGroupEntity.
Return type:int
swagger_types = {'active_remote_port_count': 'int', 'bulletins': 'list[BulletinEntity]', 'component': 'ProcessGroupDTO', 'disabled_count': 'int', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'invalid_count': 'int', 'local_input_port_count': 'int', 'local_output_port_count': 'int', 'locally_modified_and_stale_count': 'int', 'locally_modified_count': 'int', 'output_port_count': 'int', 'parameter_context': 'ParameterContextReferenceEntity', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'public_input_port_count': 'int', 'public_output_port_count': 'int', 'revision': 'RevisionDTO', 'running_count': 'int', 'stale_count': 'int', 'status': 'ProcessGroupStatusDTO', 'stopped_count': 'int', 'sync_failure_count': 'int', 'up_to_date_count': 'int', 'uri': 'str', 'versioned_flow_snapshot': 'VersionedFlowSnapshot', 'versioned_flow_state': 'str'}
sync_failure_count

Gets the sync_failure_count of this ProcessGroupEntity. The number of versioned process groups in the process group that are unable to sync to a registry.

Returns:The sync_failure_count of this ProcessGroupEntity.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

up_to_date_count

Gets the up_to_date_count of this ProcessGroupEntity. The number of up to date versioned process groups in the process group.

Returns:The up_to_date_count of this ProcessGroupEntity.
Return type:int
uri

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

Returns:The uri of this ProcessGroupEntity.
Return type:str
versioned_flow_snapshot

Gets the versioned_flow_snapshot of this ProcessGroupEntity. Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported

Returns:The versioned_flow_snapshot of this ProcessGroupEntity.
Return type:VersionedFlowSnapshot
versioned_flow_state

Gets the versioned_flow_state of this ProcessGroupEntity. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The versioned_flow_state of this ProcessGroupEntity.
Return type:str

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_flow_dto.ProcessGroupFlowDTO(id=None, uri=None, parent_group_id=None, parameter_context=None, breadcrumb=None, flow=None, last_refreshed=None)[source]

Bases: object

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

ProcessGroupFlowDTO - a model defined in Swagger

attribute_map = {'breadcrumb': 'breadcrumb', 'flow': 'flow', 'id': 'id', 'last_refreshed': 'lastRefreshed', 'parameter_context': 'parameterContext', 'parent_group_id': 'parentGroupId', 'uri': 'uri'}
breadcrumb

Gets the breadcrumb of this ProcessGroupFlowDTO. The breadcrumb of the process group.

Returns:The breadcrumb of this ProcessGroupFlowDTO.
Return type:FlowBreadcrumbEntity
flow

Gets the flow of this ProcessGroupFlowDTO. The flow structure starting at this Process Group.

Returns:The flow of this ProcessGroupFlowDTO.
Return type:FlowDTO
id

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

Returns:The id of this ProcessGroupFlowDTO.
Return type:str
last_refreshed

Gets the last_refreshed of this ProcessGroupFlowDTO. The time the flow for the process group was last refreshed.

Returns:The last_refreshed of this ProcessGroupFlowDTO.
Return type:str
parameter_context

Gets the parameter_context of this ProcessGroupFlowDTO. The Parameter Context, or null if no Parameter Context has been bound to the Process Group

Returns:The parameter_context of this ProcessGroupFlowDTO.
Return type:ParameterContextReferenceEntity
parent_group_id

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

Returns:The parent_group_id of this ProcessGroupFlowDTO.
Return type:str
swagger_types = {'breadcrumb': 'FlowBreadcrumbEntity', 'flow': 'FlowDTO', 'id': 'str', 'last_refreshed': 'str', 'parameter_context': 'ParameterContextReferenceEntity', 'parent_group_id': 'str', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_flow_entity.ProcessGroupFlowEntity(permissions=None, process_group_flow=None)[source]

Bases: object

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

ProcessGroupFlowEntity - a model defined in Swagger

attribute_map = {'permissions': 'permissions', 'process_group_flow': 'processGroupFlow'}
permissions

Gets the permissions of this ProcessGroupFlowEntity. The access policy for this process group.

Returns:The permissions of this ProcessGroupFlowEntity.
Return type:PermissionsDTO
process_group_flow

Gets the process_group_flow of this ProcessGroupFlowEntity.

Returns:The process_group_flow of this ProcessGroupFlowEntity.
Return type:ProcessGroupFlowDTO
swagger_types = {'permissions': 'PermissionsDTO', 'process_group_flow': 'ProcessGroupFlowDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_dto.ProcessGroupStatusDTO(id=None, name=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None)[source]

Bases: object

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

ProcessGroupStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this ProcessGroupStatusDTO. The aggregate status of all nodes in the cluster

Returns:The aggregate_snapshot of this ProcessGroupStatusDTO.
Return type:ProcessGroupStatusSnapshotDTO
attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'stats_last_refreshed': 'statsLastRefreshed'}
id

Gets the id of this ProcessGroupStatusDTO. The ID of the Process Group

Returns:The id of this ProcessGroupStatusDTO.
Return type:str
name

Gets the name of this ProcessGroupStatusDTO. The name of the Process Group

Returns:The name of this ProcessGroupStatusDTO.
Return type:str
node_snapshots

Gets the node_snapshots of this ProcessGroupStatusDTO. The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.

Returns:The node_snapshots of this ProcessGroupStatusDTO.
Return type:list[NodeProcessGroupStatusSnapshotDTO]
stats_last_refreshed

Gets the stats_last_refreshed of this ProcessGroupStatusDTO. The time the status for the process group was last refreshed.

Returns:The stats_last_refreshed of this ProcessGroupStatusDTO.
Return type:str
swagger_types = {'aggregate_snapshot': 'ProcessGroupStatusSnapshotDTO', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeProcessGroupStatusSnapshotDTO]', 'stats_last_refreshed': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_entity.ProcessGroupStatusEntity(process_group_status=None, can_read=None)[source]

Bases: object

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

ProcessGroupStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'process_group_status': 'processGroupStatus'}
can_read

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

Returns:The can_read of this ProcessGroupStatusEntity.
Return type:bool
process_group_status

Gets the process_group_status of this ProcessGroupStatusEntity.

Returns:The process_group_status of this ProcessGroupStatusEntity.
Return type:ProcessGroupStatusDTO
swagger_types = {'can_read': 'bool', 'process_group_status': 'ProcessGroupStatusDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_snapshot_dto.ProcessGroupStatusSnapshotDTO(id=None, name=None, connection_status_snapshots=None, processor_status_snapshots=None, process_group_status_snapshots=None, remote_process_group_status_snapshots=None, input_port_status_snapshots=None, output_port_status_snapshots=None, versioned_flow_state=None, flow_files_in=None, bytes_in=None, input=None, flow_files_queued=None, bytes_queued=None, queued=None, queued_count=None, queued_size=None, bytes_read=None, read=None, bytes_written=None, written=None, flow_files_out=None, bytes_out=None, output=None, flow_files_transferred=None, bytes_transferred=None, transferred=None, bytes_received=None, flow_files_received=None, received=None, bytes_sent=None, flow_files_sent=None, sent=None, active_thread_count=None, terminated_thread_count=None)[source]

Bases: object

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

ProcessGroupStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ProcessGroupStatusSnapshotDTO. The active thread count for this process group.

Returns:The active_thread_count of this ProcessGroupStatusSnapshotDTO.
Return type:int
attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_queued': 'bytesQueued', 'bytes_read': 'bytesRead', 'bytes_received': 'bytesReceived', 'bytes_sent': 'bytesSent', 'bytes_transferred': 'bytesTransferred', 'bytes_written': 'bytesWritten', 'connection_status_snapshots': 'connectionStatusSnapshots', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'flow_files_queued': 'flowFilesQueued', 'flow_files_received': 'flowFilesReceived', 'flow_files_sent': 'flowFilesSent', 'flow_files_transferred': 'flowFilesTransferred', 'id': 'id', 'input': 'input', 'input_port_status_snapshots': 'inputPortStatusSnapshots', 'name': 'name', 'output': 'output', 'output_port_status_snapshots': 'outputPortStatusSnapshots', 'process_group_status_snapshots': 'processGroupStatusSnapshots', 'processor_status_snapshots': 'processorStatusSnapshots', 'queued': 'queued', 'queued_count': 'queuedCount', 'queued_size': 'queuedSize', 'read': 'read', 'received': 'received', 'remote_process_group_status_snapshots': 'remoteProcessGroupStatusSnapshots', 'sent': 'sent', 'terminated_thread_count': 'terminatedThreadCount', 'transferred': 'transferred', 'versioned_flow_state': 'versionedFlowState', 'written': 'written'}
bytes_in

Gets the bytes_in of this ProcessGroupStatusSnapshotDTO. The number of bytes that have come into this ProcessGroup in the last 5 minutes

Returns:The bytes_in of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_out

Gets the bytes_out of this ProcessGroupStatusSnapshotDTO. The number of bytes transferred out of this ProcessGroup in the last 5 minutes

Returns:The bytes_out of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_queued

Gets the bytes_queued of this ProcessGroupStatusSnapshotDTO. The number of bytes that are queued up in this ProcessGroup right now

Returns:The bytes_queued of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_read

Gets the bytes_read of this ProcessGroupStatusSnapshotDTO. The number of bytes read by components in this ProcessGroup in the last 5 minutes

Returns:The bytes_read of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_received

Gets the bytes_received of this ProcessGroupStatusSnapshotDTO. The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes

Returns:The bytes_received of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_sent

Gets the bytes_sent of this ProcessGroupStatusSnapshotDTO. The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes

Returns:The bytes_sent of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_transferred

Gets the bytes_transferred of this ProcessGroupStatusSnapshotDTO. The number of bytes transferred in this ProcessGroup in the last 5 minutes

Returns:The bytes_transferred of this ProcessGroupStatusSnapshotDTO.
Return type:int
bytes_written

Gets the bytes_written of this ProcessGroupStatusSnapshotDTO. The number of bytes written by components in this ProcessGroup in the last 5 minutes

Returns:The bytes_written of this ProcessGroupStatusSnapshotDTO.
Return type:int
connection_status_snapshots

Gets the connection_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all connections in the process group.

Returns:The connection_status_snapshots of this ProcessGroupStatusSnapshotDTO.
Return type:list[ConnectionStatusSnapshotEntity]
flow_files_in

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

Returns:The flow_files_in of this ProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_out

Gets the flow_files_out of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes

Returns:The flow_files_out of this ProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_queued

Gets the flow_files_queued of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles that are queued up in this ProcessGroup right now

Returns:The flow_files_queued of this ProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_received

Gets the flow_files_received of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes

Returns:The flow_files_received of this ProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_sent

Gets the flow_files_sent of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes

Returns:The flow_files_sent of this ProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_transferred

Gets the flow_files_transferred of this ProcessGroupStatusSnapshotDTO. The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes

Returns:The flow_files_transferred of this ProcessGroupStatusSnapshotDTO.
Return type:int
id

Gets the id of this ProcessGroupStatusSnapshotDTO. The id of the process group.

Returns:The id of this ProcessGroupStatusSnapshotDTO.
Return type:str
input

Gets the input of this ProcessGroupStatusSnapshotDTO. The input count/size for the process group in the last 5 minutes (pretty printed).

Returns:The input of this ProcessGroupStatusSnapshotDTO.
Return type:str
input_port_status_snapshots

Gets the input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all input ports in the process group.

Returns:The input_port_status_snapshots of this ProcessGroupStatusSnapshotDTO.
Return type:list[PortStatusSnapshotEntity]
name

Gets the name of this ProcessGroupStatusSnapshotDTO. The name of this process group.

Returns:The name of this ProcessGroupStatusSnapshotDTO.
Return type:str
output

Gets the output of this ProcessGroupStatusSnapshotDTO. The output count/size for the process group in the last 5 minutes.

Returns:The output of this ProcessGroupStatusSnapshotDTO.
Return type:str
output_port_status_snapshots

Gets the output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all output ports in the process group.

Returns:The output_port_status_snapshots of this ProcessGroupStatusSnapshotDTO.
Return type:list[PortStatusSnapshotEntity]
process_group_status_snapshots

Gets the process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all process groups in the process group.

Returns:The process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO.
Return type:list[ProcessGroupStatusSnapshotEntity]
processor_status_snapshots

Gets the processor_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all processors in the process group.

Returns:The processor_status_snapshots of this ProcessGroupStatusSnapshotDTO.
Return type:list[ProcessorStatusSnapshotEntity]
queued

Gets the queued of this ProcessGroupStatusSnapshotDTO. The count/size that is queued in the the process group.

Returns:The queued of this ProcessGroupStatusSnapshotDTO.
Return type:str
queued_count

Gets the queued_count of this ProcessGroupStatusSnapshotDTO. The count that is queued for the process group.

Returns:The queued_count of this ProcessGroupStatusSnapshotDTO.
Return type:str
queued_size

Gets the queued_size of this ProcessGroupStatusSnapshotDTO. The size that is queued for the process group.

Returns:The queued_size of this ProcessGroupStatusSnapshotDTO.
Return type:str
read

Gets the read of this ProcessGroupStatusSnapshotDTO. The number of bytes read in the last 5 minutes.

Returns:The read of this ProcessGroupStatusSnapshotDTO.
Return type:str
received

Gets the received of this ProcessGroupStatusSnapshotDTO. The count/size sent to the process group in the last 5 minutes.

Returns:The received of this ProcessGroupStatusSnapshotDTO.
Return type:str
remote_process_group_status_snapshots

Gets the remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO. The status of all remote process groups in the process group.

Returns:The remote_process_group_status_snapshots of this ProcessGroupStatusSnapshotDTO.
Return type:list[RemoteProcessGroupStatusSnapshotEntity]
sent

Gets the sent of this ProcessGroupStatusSnapshotDTO. The count/size sent from this process group in the last 5 minutes.

Returns:The sent of this ProcessGroupStatusSnapshotDTO.
Return type:str
swagger_types = {'active_thread_count': 'int', 'bytes_in': 'int', 'bytes_out': 'int', 'bytes_queued': 'int', 'bytes_read': 'int', 'bytes_received': 'int', 'bytes_sent': 'int', 'bytes_transferred': 'int', 'bytes_written': 'int', 'connection_status_snapshots': 'list[ConnectionStatusSnapshotEntity]', 'flow_files_in': 'int', 'flow_files_out': 'int', 'flow_files_queued': 'int', 'flow_files_received': 'int', 'flow_files_sent': 'int', 'flow_files_transferred': 'int', 'id': 'str', 'input': 'str', 'input_port_status_snapshots': 'list[PortStatusSnapshotEntity]', 'name': 'str', 'output': 'str', 'output_port_status_snapshots': 'list[PortStatusSnapshotEntity]', 'process_group_status_snapshots': 'list[ProcessGroupStatusSnapshotEntity]', 'processor_status_snapshots': 'list[ProcessorStatusSnapshotEntity]', 'queued': 'str', 'queued_count': 'str', 'queued_size': 'str', 'read': 'str', 'received': 'str', 'remote_process_group_status_snapshots': 'list[RemoteProcessGroupStatusSnapshotEntity]', 'sent': 'str', 'terminated_thread_count': 'int', 'transferred': 'str', 'versioned_flow_state': 'str', 'written': 'str'}
terminated_thread_count

Gets the terminated_thread_count of this ProcessGroupStatusSnapshotDTO. The number of threads currently terminated for the process group.

Returns:The terminated_thread_count of this ProcessGroupStatusSnapshotDTO.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transferred

Gets the transferred of this ProcessGroupStatusSnapshotDTO. The count/size transferred to/from queues in the process group in the last 5 minutes.

Returns:The transferred of this ProcessGroupStatusSnapshotDTO.
Return type:str
versioned_flow_state

Gets the versioned_flow_state of this ProcessGroupStatusSnapshotDTO. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The versioned_flow_state of this ProcessGroupStatusSnapshotDTO.
Return type:str
written

Gets the written of this ProcessGroupStatusSnapshotDTO. The number of bytes written in the last 5 minutes.

Returns:The written of this ProcessGroupStatusSnapshotDTO.
Return type:str

nipyapi.nifi.models.process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_group_status_snapshot_entity.ProcessGroupStatusSnapshotEntity(id=None, process_group_status_snapshot=None, can_read=None)[source]

Bases: object

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

ProcessGroupStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'process_group_status_snapshot': 'processGroupStatusSnapshot'}
can_read

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

Returns:The can_read of this ProcessGroupStatusSnapshotEntity.
Return type:bool
id

Gets the id of this ProcessGroupStatusSnapshotEntity. The id of the process group.

Returns:The id of this ProcessGroupStatusSnapshotEntity.
Return type:str
process_group_status_snapshot

Gets the process_group_status_snapshot of this ProcessGroupStatusSnapshotEntity.

Returns:The process_group_status_snapshot of this ProcessGroupStatusSnapshotEntity.
Return type:ProcessGroupStatusSnapshotDTO
swagger_types = {'can_read': 'bool', 'id': 'str', 'process_group_status_snapshot': 'ProcessGroupStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.process_groups_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.process_groups_entity.ProcessGroupsEntity(process_groups=None)[source]

Bases: object

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

ProcessGroupsEntity - a model defined in Swagger

attribute_map = {'process_groups': 'processGroups'}
process_groups

Gets the process_groups of this ProcessGroupsEntity.

Returns:The process_groups of this ProcessGroupsEntity.
Return type:list[ProcessGroupEntity]
swagger_types = {'process_groups': 'list[ProcessGroupEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.processor_config_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_config_dto.ProcessorConfigDTO(properties=None, descriptors=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, comments=None, custom_ui_url=None, loss_tolerant=None, annotation_data=None, default_concurrent_tasks=None, default_scheduling_period=None)[source]

Bases: object

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

ProcessorConfigDTO - a model defined in Swagger

annotation_data

Gets the annotation_data of this ProcessorConfigDTO. The annotation data for the processor used to relay configuration between a custom UI and the procesosr.

Returns:The annotation_data of this ProcessorConfigDTO.
Return type:str
attribute_map = {'annotation_data': 'annotationData', 'auto_terminated_relationships': 'autoTerminatedRelationships', 'bulletin_level': 'bulletinLevel', 'comments': 'comments', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'custom_ui_url': 'customUiUrl', 'default_concurrent_tasks': 'defaultConcurrentTasks', 'default_scheduling_period': 'defaultSchedulingPeriod', 'descriptors': 'descriptors', 'execution_node': 'executionNode', 'loss_tolerant': 'lossTolerant', 'penalty_duration': 'penaltyDuration', 'properties': 'properties', 'run_duration_millis': 'runDurationMillis', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'yield_duration': 'yieldDuration'}
auto_terminated_relationships

Gets the auto_terminated_relationships of this ProcessorConfigDTO. The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the ‘isAutoTerminate’ property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.

Returns:The auto_terminated_relationships of this ProcessorConfigDTO.
Return type:list[str]
bulletin_level

Gets the bulletin_level of this ProcessorConfigDTO. The level at which the processor will report bulletins.

Returns:The bulletin_level of this ProcessorConfigDTO.
Return type:str
comments

Gets the comments of this ProcessorConfigDTO. The comments for the processor.

Returns:The comments of this ProcessorConfigDTO.
Return type:str
concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this ProcessorConfigDTO. The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.

Returns:The concurrently_schedulable_task_count of this ProcessorConfigDTO.
Return type:int
custom_ui_url

Gets the custom_ui_url of this ProcessorConfigDTO. The URL for the processor’s custom configuration UI if applicable.

Returns:The custom_ui_url of this ProcessorConfigDTO.
Return type:str
default_concurrent_tasks

Gets the default_concurrent_tasks of this ProcessorConfigDTO. Maps default values for concurrent tasks for each applicable scheduling strategy.

Returns:The default_concurrent_tasks of this ProcessorConfigDTO.
Return type:dict(str, str)
default_scheduling_period

Gets the default_scheduling_period of this ProcessorConfigDTO. Maps default values for scheduling period for each applicable scheduling strategy.

Returns:The default_scheduling_period of this ProcessorConfigDTO.
Return type:dict(str, str)
descriptors

Gets the descriptors of this ProcessorConfigDTO. Descriptors for the processor’s properties.

Returns:The descriptors of this ProcessorConfigDTO.
Return type:dict(str, PropertyDescriptorDTO)
execution_node

Gets the execution_node of this ProcessorConfigDTO. Indicates the node where the process will execute.

Returns:The execution_node of this ProcessorConfigDTO.
Return type:str
loss_tolerant

Gets the loss_tolerant of this ProcessorConfigDTO. Whether the processor is loss tolerant.

Returns:The loss_tolerant of this ProcessorConfigDTO.
Return type:bool
penalty_duration

Gets the penalty_duration of this ProcessorConfigDTO. The amount of time that is used when the process penalizes a flowfile.

Returns:The penalty_duration of this ProcessorConfigDTO.
Return type:str
properties

Gets the properties of this ProcessorConfigDTO. The properties for the processor. Properties whose value is not set will only contain the property name.

Returns:The properties of this ProcessorConfigDTO.
Return type:dict(str, str)
run_duration_millis

Gets the run_duration_millis of this ProcessorConfigDTO. The run duration for the processor in milliseconds.

Returns:The run_duration_millis of this ProcessorConfigDTO.
Return type:int
scheduling_period

Gets the scheduling_period of this ProcessorConfigDTO. The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.

Returns:The scheduling_period of this ProcessorConfigDTO.
Return type:str
scheduling_strategy

Gets the scheduling_strategy of this ProcessorConfigDTO. Indcates whether the prcessor should be scheduled to run in event or timer driven mode.

Returns:The scheduling_strategy of this ProcessorConfigDTO.
Return type:str
swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'bulletin_level': 'str', 'comments': 'str', 'concurrently_schedulable_task_count': 'int', 'custom_ui_url': 'str', 'default_concurrent_tasks': 'dict(str, str)', 'default_scheduling_period': 'dict(str, str)', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'execution_node': 'str', 'loss_tolerant': 'bool', 'penalty_duration': 'str', 'properties': 'dict(str, str)', 'run_duration_millis': 'int', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'yield_duration': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

yield_duration

Gets the yield_duration of this ProcessorConfigDTO. The amount of time that must elapse before this processor is scheduled again after yielding.

Returns:The yield_duration of this ProcessorConfigDTO.
Return type:str

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_dto.ProcessorDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, state=None, style=None, relationships=None, description=None, supports_parallel_processing=None, supports_event_driven=None, supports_batching=None, persists_state=None, restricted=None, deprecated=None, execution_node_restricted=None, multiple_versions_available=None, input_requirement=None, config=None, validation_errors=None, validation_status=None, extension_missing=None)[source]

Bases: object

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

ProcessorDTO - a model defined in Swagger

attribute_map = {'bundle': 'bundle', 'config': 'config', 'deprecated': 'deprecated', 'description': 'description', 'execution_node_restricted': 'executionNodeRestricted', 'extension_missing': 'extensionMissing', 'id': 'id', 'input_requirement': 'inputRequirement', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'relationships': 'relationships', 'restricted': 'restricted', 'state': 'state', 'style': 'style', 'supports_batching': 'supportsBatching', 'supports_event_driven': 'supportsEventDriven', 'supports_parallel_processing': 'supportsParallelProcessing', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}
bundle

Gets the bundle of this ProcessorDTO. The details of the artifact that bundled this processor type.

Returns:The bundle of this ProcessorDTO.
Return type:BundleDTO
config

Gets the config of this ProcessorDTO. The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.

Returns:The config of this ProcessorDTO.
Return type:ProcessorConfigDTO
deprecated

Gets the deprecated of this ProcessorDTO. Whether the processor has been deprecated.

Returns:The deprecated of this ProcessorDTO.
Return type:bool
description

Gets the description of this ProcessorDTO. The description of the processor.

Returns:The description of this ProcessorDTO.
Return type:str
execution_node_restricted

Gets the execution_node_restricted of this ProcessorDTO. Indicates if the execution node of a processor is restricted to run only on the primary node

Returns:The execution_node_restricted of this ProcessorDTO.
Return type:bool
extension_missing

Gets the extension_missing of this ProcessorDTO. Whether the underlying extension is missing.

Returns:The extension_missing of this ProcessorDTO.
Return type:bool
id

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

Returns:The id of this ProcessorDTO.
Return type:str
input_requirement

Gets the input_requirement of this ProcessorDTO. The input requirement for this processor.

Returns:The input_requirement of this ProcessorDTO.
Return type:str
multiple_versions_available

Gets the multiple_versions_available of this ProcessorDTO. Whether the processor has multiple versions available.

Returns:The multiple_versions_available of this ProcessorDTO.
Return type:bool
name

Gets the name of this ProcessorDTO. The name of the processor.

Returns:The name of this ProcessorDTO.
Return type:str
parent_group_id

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

Returns:The parent_group_id of this ProcessorDTO.
Return type:str
persists_state

Gets the persists_state of this ProcessorDTO. Whether the processor persists state.

Returns:The persists_state of this ProcessorDTO.
Return type:bool
position

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

Returns:The position of this ProcessorDTO.
Return type:PositionDTO
relationships

Gets the relationships of this ProcessorDTO. The available relationships that the processor currently supports.

Returns:The relationships of this ProcessorDTO.
Return type:list[RelationshipDTO]
restricted

Gets the restricted of this ProcessorDTO. Whether the processor requires elevated privileges.

Returns:The restricted of this ProcessorDTO.
Return type:bool
state

Gets the state of this ProcessorDTO. The state of the processor

Returns:The state of this ProcessorDTO.
Return type:str
style

Gets the style of this ProcessorDTO. Styles for the processor (background-color : #eee).

Returns:The style of this ProcessorDTO.
Return type:dict(str, str)
supports_batching

Gets the supports_batching of this ProcessorDTO. Whether the processor supports batching. This makes the run duration settings available.

Returns:The supports_batching of this ProcessorDTO.
Return type:bool
supports_event_driven

Gets the supports_event_driven of this ProcessorDTO. Whether the processor supports event driven scheduling.

Returns:The supports_event_driven of this ProcessorDTO.
Return type:bool
supports_parallel_processing

Gets the supports_parallel_processing of this ProcessorDTO. Whether the processor supports parallel processing.

Returns:The supports_parallel_processing of this ProcessorDTO.
Return type:bool
swagger_types = {'bundle': 'BundleDTO', 'config': 'ProcessorConfigDTO', 'deprecated': 'bool', 'description': 'str', 'execution_node_restricted': 'bool', 'extension_missing': 'bool', 'id': 'str', 'input_requirement': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'relationships': 'list[RelationshipDTO]', 'restricted': 'bool', 'state': 'str', 'style': 'dict(str, str)', 'supports_batching': 'bool', 'supports_event_driven': 'bool', 'supports_parallel_processing': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this ProcessorDTO. The type of the processor.

Returns:The type of this ProcessorDTO.
Return type:str
validation_errors

Gets the validation_errors of this ProcessorDTO. The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.

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

Gets the validation_status of this ProcessorDTO. Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)

Returns:The validation_status of this ProcessorDTO.
Return type:str
versioned_component_id

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

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

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_entity.ProcessorEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, input_requirement=None, status=None, operate_permissions=None)[source]

Bases: object

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

ProcessorEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'input_requirement': 'inputRequirement', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}
bulletins

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

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

Gets the component of this ProcessorEntity.

Returns:The component of this ProcessorEntity.
Return type:ProcessorDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this ProcessorEntity.
Return type:bool
id

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

Returns:The id of this ProcessorEntity.
Return type:str
input_requirement

Gets the input_requirement of this ProcessorEntity. The input requirement for this processor.

Returns:The input_requirement of this ProcessorEntity.
Return type:str
operate_permissions

Gets the operate_permissions of this ProcessorEntity. The permissions for this component operations.

Returns:The operate_permissions of this ProcessorEntity.
Return type:PermissionsDTO
permissions

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

Returns:The permissions of this ProcessorEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this ProcessorEntity.
Return type:PositionDTO
revision

Gets the revision of this ProcessorEntity. 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 ProcessorEntity.
Return type:RevisionDTO
status

Gets the status of this ProcessorEntity.

Returns:The status of this ProcessorEntity.
Return type:ProcessorStatusDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ProcessorDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'input_requirement': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'ProcessorStatusDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_dto.ProcessorStatusDTO(group_id=None, id=None, name=None, type=None, run_status=None, stats_last_refreshed=None, aggregate_snapshot=None, node_snapshots=None)[source]

Bases: object

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

ProcessorStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this ProcessorStatusDTO. A status snapshot that represents the aggregate stats 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 ProcessorStatusDTO.
Return type:ProcessorStatusSnapshotDTO
attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'run_status': 'runStatus', 'stats_last_refreshed': 'statsLastRefreshed', 'type': 'type'}
group_id

Gets the group_id of this ProcessorStatusDTO. The unique ID of the process group that the Processor belongs to

Returns:The group_id of this ProcessorStatusDTO.
Return type:str
id

Gets the id of this ProcessorStatusDTO. The unique ID of the Processor

Returns:The id of this ProcessorStatusDTO.
Return type:str
name

Gets the name of this ProcessorStatusDTO. The name of the Processor

Returns:The name of this ProcessorStatusDTO.
Return type:str
node_snapshots

Gets the node_snapshots of this ProcessorStatusDTO. A status 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 ProcessorStatusDTO.
Return type:list[NodeProcessorStatusSnapshotDTO]
run_status

Gets the run_status of this ProcessorStatusDTO. The run status of the Processor

Returns:The run_status of this ProcessorStatusDTO.
Return type:str
stats_last_refreshed

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

Returns:The stats_last_refreshed of this ProcessorStatusDTO.
Return type:str
swagger_types = {'aggregate_snapshot': 'ProcessorStatusSnapshotDTO', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeProcessorStatusSnapshotDTO]', 'run_status': 'str', 'stats_last_refreshed': 'str', 'type': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this ProcessorStatusDTO. The type of the Processor

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

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_entity.ProcessorStatusEntity(processor_status=None, can_read=None)[source]

Bases: object

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

ProcessorStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'processor_status': 'processorStatus'}
can_read

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

Returns:The can_read of this ProcessorStatusEntity.
Return type:bool
processor_status

Gets the processor_status of this ProcessorStatusEntity.

Returns:The processor_status of this ProcessorStatusEntity.
Return type:ProcessorStatusDTO
swagger_types = {'can_read': 'bool', 'processor_status': 'ProcessorStatusDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_snapshot_dto.ProcessorStatusSnapshotDTO(id=None, group_id=None, name=None, type=None, run_status=None, execution_node=None, bytes_read=None, bytes_written=None, read=None, written=None, flow_files_in=None, bytes_in=None, input=None, flow_files_out=None, bytes_out=None, output=None, task_count=None, tasks_duration_nanos=None, tasks=None, tasks_duration=None, active_thread_count=None, terminated_thread_count=None)[source]

Bases: object

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

ProcessorStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ProcessorStatusSnapshotDTO. The number of threads currently executing in the processor.

Returns:The active_thread_count of this ProcessorStatusSnapshotDTO.
Return type:int
attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_read': 'bytesRead', 'bytes_written': 'bytesWritten', 'execution_node': 'executionNode', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'name': 'name', 'output': 'output', 'read': 'read', 'run_status': 'runStatus', 'task_count': 'taskCount', 'tasks': 'tasks', 'tasks_duration': 'tasksDuration', 'tasks_duration_nanos': 'tasksDurationNanos', 'terminated_thread_count': 'terminatedThreadCount', 'type': 'type', 'written': 'written'}
bytes_in

Gets the bytes_in of this ProcessorStatusSnapshotDTO. The size of the FlowFiles that have been accepted in the last 5 minutes

Returns:The bytes_in of this ProcessorStatusSnapshotDTO.
Return type:int
bytes_out

Gets the bytes_out of this ProcessorStatusSnapshotDTO. The size of the FlowFiles transferred to a Connection in the last 5 minutes

Returns:The bytes_out of this ProcessorStatusSnapshotDTO.
Return type:int
bytes_read

Gets the bytes_read of this ProcessorStatusSnapshotDTO. The number of bytes read by this Processor in the last 5 mintues

Returns:The bytes_read of this ProcessorStatusSnapshotDTO.
Return type:int
bytes_written

Gets the bytes_written of this ProcessorStatusSnapshotDTO. The number of bytes written by this Processor in the last 5 minutes

Returns:The bytes_written of this ProcessorStatusSnapshotDTO.
Return type:int
execution_node

Gets the execution_node of this ProcessorStatusSnapshotDTO. Indicates the node where the process will execute.

Returns:The execution_node of this ProcessorStatusSnapshotDTO.
Return type:str
flow_files_in

Gets the flow_files_in of this ProcessorStatusSnapshotDTO. The number of FlowFiles that have been accepted in the last 5 minutes

Returns:The flow_files_in of this ProcessorStatusSnapshotDTO.
Return type:int
flow_files_out

Gets the flow_files_out of this ProcessorStatusSnapshotDTO. The number of FlowFiles transferred to a Connection in the last 5 minutes

Returns:The flow_files_out of this ProcessorStatusSnapshotDTO.
Return type:int
group_id

Gets the group_id of this ProcessorStatusSnapshotDTO. The id of the parent process group to which the processor belongs.

Returns:The group_id of this ProcessorStatusSnapshotDTO.
Return type:str
id

Gets the id of this ProcessorStatusSnapshotDTO. The id of the processor.

Returns:The id of this ProcessorStatusSnapshotDTO.
Return type:str
input

Gets the input of this ProcessorStatusSnapshotDTO. The count/size of flowfiles that have been accepted in the last 5 minutes.

Returns:The input of this ProcessorStatusSnapshotDTO.
Return type:str
name

Gets the name of this ProcessorStatusSnapshotDTO. The name of the prcessor.

Returns:The name of this ProcessorStatusSnapshotDTO.
Return type:str
output

Gets the output of this ProcessorStatusSnapshotDTO. The count/size of flowfiles that have been processed in the last 5 minutes.

Returns:The output of this ProcessorStatusSnapshotDTO.
Return type:str
read

Gets the read of this ProcessorStatusSnapshotDTO. The number of bytes read in the last 5 minutes.

Returns:The read of this ProcessorStatusSnapshotDTO.
Return type:str
run_status

Gets the run_status of this ProcessorStatusSnapshotDTO. The state of the processor.

Returns:The run_status of this ProcessorStatusSnapshotDTO.
Return type:str
swagger_types = {'active_thread_count': 'int', 'bytes_in': 'int', 'bytes_out': 'int', 'bytes_read': 'int', 'bytes_written': 'int', 'execution_node': 'str', 'flow_files_in': 'int', 'flow_files_out': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'name': 'str', 'output': 'str', 'read': 'str', 'run_status': 'str', 'task_count': 'int', 'tasks': 'str', 'tasks_duration': 'str', 'tasks_duration_nanos': 'int', 'terminated_thread_count': 'int', 'type': 'str', 'written': 'str'}
task_count

Gets the task_count of this ProcessorStatusSnapshotDTO. The number of times this Processor has run in the last 5 minutes

Returns:The task_count of this ProcessorStatusSnapshotDTO.
Return type:int
tasks

Gets the tasks of this ProcessorStatusSnapshotDTO. The total number of task this connectable has completed over the last 5 minutes.

Returns:The tasks of this ProcessorStatusSnapshotDTO.
Return type:str
tasks_duration

Gets the tasks_duration of this ProcessorStatusSnapshotDTO. The total duration of all tasks for this connectable over the last 5 minutes.

Returns:The tasks_duration of this ProcessorStatusSnapshotDTO.
Return type:str
tasks_duration_nanos

Gets the tasks_duration_nanos of this ProcessorStatusSnapshotDTO. The number of nanoseconds that this Processor has spent running in the last 5 minutes

Returns:The tasks_duration_nanos of this ProcessorStatusSnapshotDTO.
Return type:int
terminated_thread_count

Gets the terminated_thread_count of this ProcessorStatusSnapshotDTO. The number of threads currently terminated for the processor.

Returns:The terminated_thread_count of this ProcessorStatusSnapshotDTO.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this ProcessorStatusSnapshotDTO. The type of the processor.

Returns:The type of this ProcessorStatusSnapshotDTO.
Return type:str
written

Gets the written of this ProcessorStatusSnapshotDTO. The number of bytes written in the last 5 minutes.

Returns:The written of this ProcessorStatusSnapshotDTO.
Return type:str

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_status_snapshot_entity.ProcessorStatusSnapshotEntity(id=None, processor_status_snapshot=None, can_read=None)[source]

Bases: object

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

ProcessorStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'processor_status_snapshot': 'processorStatusSnapshot'}
can_read

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

Returns:The can_read of this ProcessorStatusSnapshotEntity.
Return type:bool
id

Gets the id of this ProcessorStatusSnapshotEntity. The id of the processor.

Returns:The id of this ProcessorStatusSnapshotEntity.
Return type:str
processor_status_snapshot

Gets the processor_status_snapshot of this ProcessorStatusSnapshotEntity.

Returns:The processor_status_snapshot of this ProcessorStatusSnapshotEntity.
Return type:ProcessorStatusSnapshotDTO
swagger_types = {'can_read': 'bool', 'id': 'str', 'processor_status_snapshot': 'ProcessorStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.processor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processor_types_entity.ProcessorTypesEntity(processor_types=None)[source]

Bases: object

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

ProcessorTypesEntity - a model defined in Swagger

attribute_map = {'processor_types': 'processorTypes'}
processor_types

Gets the processor_types of this ProcessorTypesEntity.

Returns:The processor_types of this ProcessorTypesEntity.
Return type:list[DocumentedTypeDTO]
swagger_types = {'processor_types': 'list[DocumentedTypeDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.processors_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.processors_entity.ProcessorsEntity(processors=None)[source]

Bases: object

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

ProcessorsEntity - a model defined in Swagger

attribute_map = {'processors': 'processors'}
processors

Gets the processors of this ProcessorsEntity.

Returns:The processors of this ProcessorsEntity.
Return type:list[ProcessorEntity]
swagger_types = {'processors': 'list[ProcessorEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.property_descriptor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.property_descriptor_dto.PropertyDescriptorDTO(name=None, display_name=None, description=None, default_value=None, allowable_values=None, required=None, sensitive=None, dynamic=None, supports_el=None, expression_language_scope=None, identifies_controller_service=None, identifies_controller_service_bundle=None)[source]

Bases: object

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

PropertyDescriptorDTO - a model defined in Swagger

allowable_values

Gets the allowable_values of this PropertyDescriptorDTO. Allowable values for the property. If empty then the allowed values are not constrained.

Returns:The allowable_values of this PropertyDescriptorDTO.
Return type:list[AllowableValueEntity]
attribute_map = {'allowable_values': 'allowableValues', 'default_value': 'defaultValue', 'description': 'description', 'display_name': 'displayName', 'dynamic': 'dynamic', 'expression_language_scope': 'expressionLanguageScope', 'identifies_controller_service': 'identifiesControllerService', 'identifies_controller_service_bundle': 'identifiesControllerServiceBundle', 'name': 'name', 'required': 'required', 'sensitive': 'sensitive', 'supports_el': 'supportsEl'}
default_value

Gets the default_value of this PropertyDescriptorDTO. The default value for the property.

Returns:The default_value of this PropertyDescriptorDTO.
Return type:str
description

Gets the description of this PropertyDescriptorDTO. The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.

Returns:The description of this PropertyDescriptorDTO.
Return type:str
display_name

Gets the display_name of this PropertyDescriptorDTO. The human readable name for the property.

Returns:The display_name of this PropertyDescriptorDTO.
Return type:str
dynamic

Gets the dynamic of this PropertyDescriptorDTO. Whether the property is dynamic (user-defined).

Returns:The dynamic of this PropertyDescriptorDTO.
Return type:bool
expression_language_scope

Gets the expression_language_scope of this PropertyDescriptorDTO. Scope of the Expression Language evaluation for the property.

Returns:The expression_language_scope of this PropertyDescriptorDTO.
Return type:str
identifies_controller_service

Gets the identifies_controller_service of this PropertyDescriptorDTO. If the property identifies a controller service this returns the fully qualified type.

Returns:The identifies_controller_service of this PropertyDescriptorDTO.
Return type:str
identifies_controller_service_bundle

Gets the identifies_controller_service_bundle of this PropertyDescriptorDTO. If the property identifies a controller service this returns the bundle of the type, null otherwise.

Returns:The identifies_controller_service_bundle of this PropertyDescriptorDTO.
Return type:BundleDTO
name

Gets the name of this PropertyDescriptorDTO. The name for the property.

Returns:The name of this PropertyDescriptorDTO.
Return type:str
required

Gets the required of this PropertyDescriptorDTO. Whether the property is required.

Returns:The required of this PropertyDescriptorDTO.
Return type:bool
sensitive

Gets the sensitive of this PropertyDescriptorDTO. Whether the property is sensitive and protected whenever stored or represented.

Returns:The sensitive of this PropertyDescriptorDTO.
Return type:bool
supports_el

Gets the supports_el of this PropertyDescriptorDTO. Whether the property supports expression language.

Returns:The supports_el of this PropertyDescriptorDTO.
Return type:bool
swagger_types = {'allowable_values': 'list[AllowableValueEntity]', 'default_value': 'str', 'description': 'str', 'display_name': 'str', 'dynamic': 'bool', 'expression_language_scope': 'str', 'identifies_controller_service': 'str', 'identifies_controller_service_bundle': 'BundleDTO', 'name': 'str', 'required': 'bool', 'sensitive': 'bool', 'supports_el': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.property_descriptor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.property_descriptor_entity.PropertyDescriptorEntity(property_descriptor=None)[source]

Bases: object

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

PropertyDescriptorEntity - a model defined in Swagger

attribute_map = {'property_descriptor': 'propertyDescriptor'}
property_descriptor

Gets the property_descriptor of this PropertyDescriptorEntity.

Returns:The property_descriptor of this PropertyDescriptorEntity.
Return type:PropertyDescriptorDTO
swagger_types = {'property_descriptor': 'PropertyDescriptorDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.property_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.property_history_dto.PropertyHistoryDTO(previous_values=None)[source]

Bases: object

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

PropertyHistoryDTO - a model defined in Swagger

attribute_map = {'previous_values': 'previousValues'}
previous_values

Gets the previous_values of this PropertyHistoryDTO. Previous values for a given property.

Returns:The previous_values of this PropertyHistoryDTO.
Return type:list[PreviousValueDTO]
swagger_types = {'previous_values': 'list[PreviousValueDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.provenance_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_dto.ProvenanceDTO(id=None, uri=None, submission_time=None, expiration=None, percent_completed=None, finished=None, request=None, results=None)[source]

Bases: object

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

ProvenanceDTO - 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 ProvenanceDTO. The timestamp when the query will expire.

Returns:The expiration of this ProvenanceDTO.
Return type:str
finished

Gets the finished of this ProvenanceDTO. Whether the query has finished.

Returns:The finished of this ProvenanceDTO.
Return type:bool
id

Gets the id of this ProvenanceDTO. The id of the provenance query.

Returns:The id of this ProvenanceDTO.
Return type:str
percent_completed

Gets the percent_completed of this ProvenanceDTO. The current percent complete.

Returns:The percent_completed of this ProvenanceDTO.
Return type:int
request

Gets the request of this ProvenanceDTO. The provenance request.

Returns:The request of this ProvenanceDTO.
Return type:ProvenanceRequestDTO
results

Gets the results of this ProvenanceDTO. The provenance results.

Returns:The results of this ProvenanceDTO.
Return type:ProvenanceResultsDTO
submission_time

Gets the submission_time of this ProvenanceDTO. The timestamp when the query was submitted.

Returns:The submission_time of this ProvenanceDTO.
Return type:str
swagger_types = {'expiration': 'str', 'finished': 'bool', 'id': 'str', 'percent_completed': 'int', 'request': 'ProvenanceRequestDTO', 'results': 'ProvenanceResultsDTO', 'submission_time': 'str', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

Gets the uri of this ProvenanceDTO. The URI for this query. Used for obtaining/deleting the request at a later time

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

nipyapi.nifi.models.provenance_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_entity.ProvenanceEntity(provenance=None)[source]

Bases: object

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

ProvenanceEntity - a model defined in Swagger

attribute_map = {'provenance': 'provenance'}
provenance

Gets the provenance of this ProvenanceEntity.

Returns:The provenance of this ProvenanceEntity.
Return type:ProvenanceDTO
swagger_types = {'provenance': 'ProvenanceDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.provenance_event_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_event_dto.ProvenanceEventDTO(id=None, event_id=None, event_time=None, event_duration=None, lineage_duration=None, event_type=None, flow_file_uuid=None, file_size=None, file_size_bytes=None, cluster_node_id=None, cluster_node_address=None, group_id=None, component_id=None, component_type=None, component_name=None, source_system_flow_file_id=None, alternate_identifier_uri=None, attributes=None, parent_uuids=None, child_uuids=None, transit_uri=None, relationship=None, details=None, content_equal=None, input_content_available=None, input_content_claim_section=None, input_content_claim_container=None, input_content_claim_identifier=None, input_content_claim_offset=None, input_content_claim_file_size=None, input_content_claim_file_size_bytes=None, output_content_available=None, output_content_claim_section=None, output_content_claim_container=None, output_content_claim_identifier=None, output_content_claim_offset=None, output_content_claim_file_size=None, output_content_claim_file_size_bytes=None, replay_available=None, replay_explanation=None, source_connection_identifier=None)[source]

Bases: object

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

ProvenanceEventDTO - a model defined in Swagger

alternate_identifier_uri

Gets the alternate_identifier_uri of this ProvenanceEventDTO. The alternate identifier uri for the fileflow for the event.

Returns:The alternate_identifier_uri of this ProvenanceEventDTO.
Return type:str
attribute_map = {'alternate_identifier_uri': 'alternateIdentifierUri', 'attributes': 'attributes', 'child_uuids': 'childUuids', 'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'component_id': 'componentId', 'component_name': 'componentName', 'component_type': 'componentType', 'content_equal': 'contentEqual', 'details': 'details', 'event_duration': 'eventDuration', 'event_id': 'eventId', 'event_time': 'eventTime', 'event_type': 'eventType', 'file_size': 'fileSize', 'file_size_bytes': 'fileSizeBytes', 'flow_file_uuid': 'flowFileUuid', 'group_id': 'groupId', 'id': 'id', 'input_content_available': 'inputContentAvailable', 'input_content_claim_container': 'inputContentClaimContainer', 'input_content_claim_file_size': 'inputContentClaimFileSize', 'input_content_claim_file_size_bytes': 'inputContentClaimFileSizeBytes', 'input_content_claim_identifier': 'inputContentClaimIdentifier', 'input_content_claim_offset': 'inputContentClaimOffset', 'input_content_claim_section': 'inputContentClaimSection', 'lineage_duration': 'lineageDuration', 'output_content_available': 'outputContentAvailable', 'output_content_claim_container': 'outputContentClaimContainer', 'output_content_claim_file_size': 'outputContentClaimFileSize', 'output_content_claim_file_size_bytes': 'outputContentClaimFileSizeBytes', 'output_content_claim_identifier': 'outputContentClaimIdentifier', 'output_content_claim_offset': 'outputContentClaimOffset', 'output_content_claim_section': 'outputContentClaimSection', 'parent_uuids': 'parentUuids', 'relationship': 'relationship', 'replay_available': 'replayAvailable', 'replay_explanation': 'replayExplanation', 'source_connection_identifier': 'sourceConnectionIdentifier', 'source_system_flow_file_id': 'sourceSystemFlowFileId', 'transit_uri': 'transitUri'}
attributes

Gets the attributes of this ProvenanceEventDTO. The attributes of the flowfile for the event.

Returns:The attributes of this ProvenanceEventDTO.
Return type:list[AttributeDTO]
child_uuids

Gets the child_uuids of this ProvenanceEventDTO. The child uuids for the event.

Returns:The child_uuids of this ProvenanceEventDTO.
Return type:list[str]
cluster_node_address

Gets the cluster_node_address of this ProvenanceEventDTO. The label for the node where the event originated.

Returns:The cluster_node_address of this ProvenanceEventDTO.
Return type:str
cluster_node_id

Gets the cluster_node_id of this ProvenanceEventDTO. The identifier for the node where the event originated.

Returns:The cluster_node_id of this ProvenanceEventDTO.
Return type:str
component_id

Gets the component_id of this ProvenanceEventDTO. The id of the component that generated the event.

Returns:The component_id of this ProvenanceEventDTO.
Return type:str
component_name

Gets the component_name of this ProvenanceEventDTO. The name of the component that generated the event.

Returns:The component_name of this ProvenanceEventDTO.
Return type:str
component_type

Gets the component_type of this ProvenanceEventDTO. The type of the component that generated the event.

Returns:The component_type of this ProvenanceEventDTO.
Return type:str
content_equal

Gets the content_equal of this ProvenanceEventDTO. Whether the input and output content claim is the same.

Returns:The content_equal of this ProvenanceEventDTO.
Return type:bool
details

Gets the details of this ProvenanceEventDTO. The event details.

Returns:The details of this ProvenanceEventDTO.
Return type:str
event_duration

Gets the event_duration of this ProvenanceEventDTO. The event duration in milliseconds.

Returns:The event_duration of this ProvenanceEventDTO.
Return type:int
event_id

Gets the event_id of this ProvenanceEventDTO. The event id. This is a one up number thats unique per node.

Returns:The event_id of this ProvenanceEventDTO.
Return type:int
event_time

Gets the event_time of this ProvenanceEventDTO. The timestamp of the event.

Returns:The event_time of this ProvenanceEventDTO.
Return type:str
event_type

Gets the event_type of this ProvenanceEventDTO. The type of the event.

Returns:The event_type of this ProvenanceEventDTO.
Return type:str
file_size

Gets the file_size of this ProvenanceEventDTO. The size of the flowfile for the event.

Returns:The file_size of this ProvenanceEventDTO.
Return type:str
file_size_bytes

Gets the file_size_bytes of this ProvenanceEventDTO. The size of the flowfile in bytes for the event.

Returns:The file_size_bytes of this ProvenanceEventDTO.
Return type:int
flow_file_uuid

Gets the flow_file_uuid of this ProvenanceEventDTO. The uuid of the flowfile for the event.

Returns:The flow_file_uuid of this ProvenanceEventDTO.
Return type:str
group_id

Gets the group_id of this ProvenanceEventDTO. The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set.

Returns:The group_id of this ProvenanceEventDTO.
Return type:str
id

Gets the id of this ProvenanceEventDTO. The event uuid.

Returns:The id of this ProvenanceEventDTO.
Return type:str
input_content_available

Gets the input_content_available of this ProvenanceEventDTO. Whether the input content is still available.

Returns:The input_content_available of this ProvenanceEventDTO.
Return type:bool
input_content_claim_container

Gets the input_content_claim_container of this ProvenanceEventDTO. The container in which the input content claim lives.

Returns:The input_content_claim_container of this ProvenanceEventDTO.
Return type:str
input_content_claim_file_size

Gets the input_content_claim_file_size of this ProvenanceEventDTO. The file size of the input content claim formatted.

Returns:The input_content_claim_file_size of this ProvenanceEventDTO.
Return type:str
input_content_claim_file_size_bytes

Gets the input_content_claim_file_size_bytes of this ProvenanceEventDTO. The file size of the intput content claim in bytes.

Returns:The input_content_claim_file_size_bytes of this ProvenanceEventDTO.
Return type:int
input_content_claim_identifier

Gets the input_content_claim_identifier of this ProvenanceEventDTO. The identifier of the input content claim.

Returns:The input_content_claim_identifier of this ProvenanceEventDTO.
Return type:str
input_content_claim_offset

Gets the input_content_claim_offset of this ProvenanceEventDTO. The offset into the input content claim where the flowfiles content begins.

Returns:The input_content_claim_offset of this ProvenanceEventDTO.
Return type:int
input_content_claim_section

Gets the input_content_claim_section of this ProvenanceEventDTO. The section in which the input content claim lives.

Returns:The input_content_claim_section of this ProvenanceEventDTO.
Return type:str
lineage_duration

Gets the lineage_duration of this ProvenanceEventDTO. The duration since the lineage began, in milliseconds.

Returns:The lineage_duration of this ProvenanceEventDTO.
Return type:int
output_content_available

Gets the output_content_available of this ProvenanceEventDTO. Whether the output content is still available.

Returns:The output_content_available of this ProvenanceEventDTO.
Return type:bool
output_content_claim_container

Gets the output_content_claim_container of this ProvenanceEventDTO. The container in which the output content claim lives.

Returns:The output_content_claim_container of this ProvenanceEventDTO.
Return type:str
output_content_claim_file_size

Gets the output_content_claim_file_size of this ProvenanceEventDTO. The file size of the output content claim formatted.

Returns:The output_content_claim_file_size of this ProvenanceEventDTO.
Return type:str
output_content_claim_file_size_bytes

Gets the output_content_claim_file_size_bytes of this ProvenanceEventDTO. The file size of the output content claim in bytes.

Returns:The output_content_claim_file_size_bytes of this ProvenanceEventDTO.
Return type:int
output_content_claim_identifier

Gets the output_content_claim_identifier of this ProvenanceEventDTO. The identifier of the output content claim.

Returns:The output_content_claim_identifier of this ProvenanceEventDTO.
Return type:str
output_content_claim_offset

Gets the output_content_claim_offset of this ProvenanceEventDTO. The offset into the output content claim where the flowfiles content begins.

Returns:The output_content_claim_offset of this ProvenanceEventDTO.
Return type:int
output_content_claim_section

Gets the output_content_claim_section of this ProvenanceEventDTO. The section in which the output content claim lives.

Returns:The output_content_claim_section of this ProvenanceEventDTO.
Return type:str
parent_uuids

Gets the parent_uuids of this ProvenanceEventDTO. The parent uuids for the event.

Returns:The parent_uuids of this ProvenanceEventDTO.
Return type:list[str]
relationship

Gets the relationship of this ProvenanceEventDTO. The relationship to which the flowfile was routed if the event is of type ROUTE.

Returns:The relationship of this ProvenanceEventDTO.
Return type:str
replay_available

Gets the replay_available of this ProvenanceEventDTO. Whether or not replay is available.

Returns:The replay_available of this ProvenanceEventDTO.
Return type:bool
replay_explanation

Gets the replay_explanation of this ProvenanceEventDTO. Explanation as to why replay is unavailable.

Returns:The replay_explanation of this ProvenanceEventDTO.
Return type:str
source_connection_identifier

Gets the source_connection_identifier of this ProvenanceEventDTO. The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event.

Returns:The source_connection_identifier of this ProvenanceEventDTO.
Return type:str
source_system_flow_file_id

Gets the source_system_flow_file_id of this ProvenanceEventDTO. The source system flowfile id.

Returns:The source_system_flow_file_id of this ProvenanceEventDTO.
Return type:str
swagger_types = {'alternate_identifier_uri': 'str', 'attributes': 'list[AttributeDTO]', 'child_uuids': 'list[str]', 'cluster_node_address': 'str', 'cluster_node_id': 'str', 'component_id': 'str', 'component_name': 'str', 'component_type': 'str', 'content_equal': 'bool', 'details': 'str', 'event_duration': 'int', 'event_id': 'int', 'event_time': 'str', 'event_type': 'str', 'file_size': 'str', 'file_size_bytes': 'int', 'flow_file_uuid': 'str', 'group_id': 'str', 'id': 'str', 'input_content_available': 'bool', 'input_content_claim_container': 'str', 'input_content_claim_file_size': 'str', 'input_content_claim_file_size_bytes': 'int', 'input_content_claim_identifier': 'str', 'input_content_claim_offset': 'int', 'input_content_claim_section': 'str', 'lineage_duration': 'int', 'output_content_available': 'bool', 'output_content_claim_container': 'str', 'output_content_claim_file_size': 'str', 'output_content_claim_file_size_bytes': 'int', 'output_content_claim_identifier': 'str', 'output_content_claim_offset': 'int', 'output_content_claim_section': 'str', 'parent_uuids': 'list[str]', 'relationship': 'str', 'replay_available': 'bool', 'replay_explanation': 'str', 'source_connection_identifier': 'str', 'source_system_flow_file_id': 'str', 'transit_uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transit_uri

Gets the transit_uri of this ProvenanceEventDTO. The source/destination system uri if the event was a RECEIVE/SEND.

Returns:The transit_uri of this ProvenanceEventDTO.
Return type:str

nipyapi.nifi.models.provenance_event_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_event_entity.ProvenanceEventEntity(provenance_event=None)[source]

Bases: object

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

ProvenanceEventEntity - a model defined in Swagger

attribute_map = {'provenance_event': 'provenanceEvent'}
provenance_event

Gets the provenance_event of this ProvenanceEventEntity.

Returns:The provenance_event of this ProvenanceEventEntity.
Return type:ProvenanceEventDTO
swagger_types = {'provenance_event': 'ProvenanceEventDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.provenance_node_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_node_dto.ProvenanceNodeDTO(id=None, flow_file_uuid=None, parent_uuids=None, child_uuids=None, cluster_node_identifier=None, type=None, event_type=None, millis=None, timestamp=None)[source]

Bases: object

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

ProvenanceNodeDTO - a model defined in Swagger

attribute_map = {'child_uuids': 'childUuids', 'cluster_node_identifier': 'clusterNodeIdentifier', 'event_type': 'eventType', 'flow_file_uuid': 'flowFileUuid', 'id': 'id', 'millis': 'millis', 'parent_uuids': 'parentUuids', 'timestamp': 'timestamp', 'type': 'type'}
child_uuids

Gets the child_uuids of this ProvenanceNodeDTO. The uuid of the childrent flowfiles of the provenance event.

Returns:The child_uuids of this ProvenanceNodeDTO.
Return type:list[str]
cluster_node_identifier

Gets the cluster_node_identifier of this ProvenanceNodeDTO. The identifier of the node that this event/flowfile originated from.

Returns:The cluster_node_identifier of this ProvenanceNodeDTO.
Return type:str
event_type

Gets the event_type of this ProvenanceNodeDTO. If the type is EVENT, this is the type of event.

Returns:The event_type of this ProvenanceNodeDTO.
Return type:str
flow_file_uuid

Gets the flow_file_uuid of this ProvenanceNodeDTO. The uuid of the flowfile associated with the provenance event.

Returns:The flow_file_uuid of this ProvenanceNodeDTO.
Return type:str
id

Gets the id of this ProvenanceNodeDTO. The id of the node.

Returns:The id of this ProvenanceNodeDTO.
Return type:str
millis

Gets the millis of this ProvenanceNodeDTO. The timestamp of the node in milliseconds.

Returns:The millis of this ProvenanceNodeDTO.
Return type:int
parent_uuids

Gets the parent_uuids of this ProvenanceNodeDTO. The uuid of the parent flowfiles of the provenance event.

Returns:The parent_uuids of this ProvenanceNodeDTO.
Return type:list[str]
swagger_types = {'child_uuids': 'list[str]', 'cluster_node_identifier': 'str', 'event_type': 'str', 'flow_file_uuid': 'str', 'id': 'str', 'millis': 'int', 'parent_uuids': 'list[str]', 'timestamp': 'str', 'type': 'str'}
timestamp

Gets the timestamp of this ProvenanceNodeDTO. The timestamp of the node formatted.

Returns:The timestamp of this ProvenanceNodeDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this ProvenanceNodeDTO. The type of the node.

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

nipyapi.nifi.models.provenance_options_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_options_dto.ProvenanceOptionsDTO(searchable_fields=None)[source]

Bases: object

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

ProvenanceOptionsDTO - a model defined in Swagger

attribute_map = {'searchable_fields': 'searchableFields'}
searchable_fields

Gets the searchable_fields of this ProvenanceOptionsDTO. The available searchable field for the NiFi.

Returns:The searchable_fields of this ProvenanceOptionsDTO.
Return type:list[ProvenanceSearchableFieldDTO]
swagger_types = {'searchable_fields': 'list[ProvenanceSearchableFieldDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.provenance_options_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_options_entity.ProvenanceOptionsEntity(provenance_options=None)[source]

Bases: object

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

ProvenanceOptionsEntity - a model defined in Swagger

attribute_map = {'provenance_options': 'provenanceOptions'}
provenance_options

Gets the provenance_options of this ProvenanceOptionsEntity.

Returns:The provenance_options of this ProvenanceOptionsEntity.
Return type:ProvenanceOptionsDTO
swagger_types = {'provenance_options': 'ProvenanceOptionsDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.provenance_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_request_dto.ProvenanceRequestDTO(search_terms=None, cluster_node_id=None, start_date=None, end_date=None, minimum_file_size=None, maximum_file_size=None, max_results=None, summarize=None, incremental_results=None)[source]

Bases: object

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

ProvenanceRequestDTO - a model defined in Swagger

attribute_map = {'cluster_node_id': 'clusterNodeId', 'end_date': 'endDate', 'incremental_results': 'incrementalResults', 'max_results': 'maxResults', 'maximum_file_size': 'maximumFileSize', 'minimum_file_size': 'minimumFileSize', 'search_terms': 'searchTerms', 'start_date': 'startDate', 'summarize': 'summarize'}
cluster_node_id

Gets the cluster_node_id of this ProvenanceRequestDTO. The id of the node in the cluster where this provenance originated.

Returns:The cluster_node_id of this ProvenanceRequestDTO.
Return type:str
end_date

Gets the end_date of this ProvenanceRequestDTO. The latest event time to include in the query.

Returns:The end_date of this ProvenanceRequestDTO.
Return type:str
incremental_results

Gets the incremental_results of this ProvenanceRequestDTO. Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

Returns:The incremental_results of this ProvenanceRequestDTO.
Return type:bool
max_results

Gets the max_results of this ProvenanceRequestDTO. The maximum number of results to include.

Returns:The max_results of this ProvenanceRequestDTO.
Return type:int
maximum_file_size

Gets the maximum_file_size of this ProvenanceRequestDTO. The maximum file size to include in the query.

Returns:The maximum_file_size of this ProvenanceRequestDTO.
Return type:str
minimum_file_size

Gets the minimum_file_size of this ProvenanceRequestDTO. The minimum file size to include in the query.

Returns:The minimum_file_size of this ProvenanceRequestDTO.
Return type:str
search_terms

Gets the search_terms of this ProvenanceRequestDTO. The search terms used to perform the search.

Returns:The search_terms of this ProvenanceRequestDTO.
Return type:dict(str, str)
start_date

Gets the start_date of this ProvenanceRequestDTO. The earliest event time to include in the query.

Returns:The start_date of this ProvenanceRequestDTO.
Return type:str
summarize

Gets the summarize of this ProvenanceRequestDTO. Whether or not to summarize provenance events returned. This property is false by default.

Returns:The summarize of this ProvenanceRequestDTO.
Return type:bool
swagger_types = {'cluster_node_id': 'str', 'end_date': 'str', 'incremental_results': 'bool', 'max_results': 'int', 'maximum_file_size': 'str', 'minimum_file_size': 'str', 'search_terms': 'dict(str, str)', 'start_date': 'str', 'summarize': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.provenance_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_results_dto.ProvenanceResultsDTO(provenance_events=None, total=None, total_count=None, generated=None, oldest_event=None, time_offset=None, errors=None)[source]

Bases: object

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

ProvenanceResultsDTO - a model defined in Swagger

attribute_map = {'errors': 'errors', 'generated': 'generated', 'oldest_event': 'oldestEvent', 'provenance_events': 'provenanceEvents', 'time_offset': 'timeOffset', 'total': 'total', 'total_count': 'totalCount'}
errors

Gets the errors of this ProvenanceResultsDTO. Any errors that occurred while performing the provenance request.

Returns:The errors of this ProvenanceResultsDTO.
Return type:list[str]
generated

Gets the generated of this ProvenanceResultsDTO. Then the search was performed.

Returns:The generated of this ProvenanceResultsDTO.
Return type:str
oldest_event

Gets the oldest_event of this ProvenanceResultsDTO. The oldest event available in the provenance repository.

Returns:The oldest_event of this ProvenanceResultsDTO.
Return type:str
provenance_events

Gets the provenance_events of this ProvenanceResultsDTO. The provenance events that matched the search criteria.

Returns:The provenance_events of this ProvenanceResultsDTO.
Return type:list[ProvenanceEventDTO]
swagger_types = {'errors': 'list[str]', 'generated': 'str', 'oldest_event': 'str', 'provenance_events': 'list[ProvenanceEventDTO]', 'time_offset': 'int', 'total': 'str', 'total_count': 'int'}
time_offset

Gets the time_offset of this ProvenanceResultsDTO. The time offset of the server that’s used for event time.

Returns:The time_offset of this ProvenanceResultsDTO.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

total

Gets the total of this ProvenanceResultsDTO. The total number of results formatted.

Returns:The total of this ProvenanceResultsDTO.
Return type:str
total_count

Gets the total_count of this ProvenanceResultsDTO. The total number of results.

Returns:The total_count of this ProvenanceResultsDTO.
Return type:int

nipyapi.nifi.models.provenance_searchable_field_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.provenance_searchable_field_dto.ProvenanceSearchableFieldDTO(id=None, field=None, label=None, type=None)[source]

Bases: object

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

ProvenanceSearchableFieldDTO - a model defined in Swagger

attribute_map = {'field': 'field', 'id': 'id', 'label': 'label', 'type': 'type'}
field

Gets the field of this ProvenanceSearchableFieldDTO. The searchable field.

Returns:The field of this ProvenanceSearchableFieldDTO.
Return type:str
id

Gets the id of this ProvenanceSearchableFieldDTO. The id of the searchable field.

Returns:The id of this ProvenanceSearchableFieldDTO.
Return type:str
label

Gets the label of this ProvenanceSearchableFieldDTO. The label for the searchable field.

Returns:The label of this ProvenanceSearchableFieldDTO.
Return type:str
swagger_types = {'field': 'str', 'id': 'str', 'label': 'str', 'type': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this ProvenanceSearchableFieldDTO. The type of the searchable field.

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

nipyapi.nifi.models.queue_size_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.queue_size_dto.QueueSizeDTO(byte_count=None, object_count=None)[source]

Bases: object

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

QueueSizeDTO - a model defined in Swagger

attribute_map = {'byte_count': 'byteCount', 'object_count': 'objectCount'}
byte_count

Gets the byte_count of this QueueSizeDTO. The size of objects in a queue.

Returns:The byte_count of this QueueSizeDTO.
Return type:int
object_count

Gets the object_count of this QueueSizeDTO. The count of objects in a queue.

Returns:The object_count of this QueueSizeDTO.
Return type:int
swagger_types = {'byte_count': 'int', 'object_count': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.registry_client_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.registry_client_entity.RegistryClientEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)[source]

Bases: object

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

RegistryClientEntity - 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 RegistryClientEntity. The bulletins for this component.

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

Gets the component of this RegistryClientEntity.

Returns:The component of this RegistryClientEntity.
Return type:RegistryDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this RegistryClientEntity.
Return type:bool
id

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

Returns:The id of this RegistryClientEntity.
Return type:str
permissions

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

Returns:The permissions of this RegistryClientEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this RegistryClientEntity.
Return type:PositionDTO
revision

Gets the revision of this RegistryClientEntity. 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 RegistryClientEntity.
Return type:RevisionDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'RegistryDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.registry_clients_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.registry_clients_entity.RegistryClientsEntity(registries=None)[source]

Bases: object

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

RegistryClientsEntity - a model defined in Swagger

attribute_map = {'registries': 'registries'}
registries

Gets the registries of this RegistryClientsEntity.

Returns:The registries of this RegistryClientsEntity.
Return type:list[RegistryClientEntity]
swagger_types = {'registries': 'list[RegistryClientEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.registry_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.registry_dto.RegistryDTO(id=None, name=None, description=None, uri=None)[source]

Bases: object

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

RegistryDTO - a model defined in Swagger

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

Gets the description of this RegistryDTO. The registry description

Returns:The description of this RegistryDTO.
Return type:str
id

Gets the id of this RegistryDTO. The registry identifier

Returns:The id of this RegistryDTO.
Return type:str
name

Gets the name of this RegistryDTO. The registry name

Returns:The name of this RegistryDTO.
Return type:str
swagger_types = {'description': 'str', 'id': 'str', 'name': 'str', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

Gets the uri of this RegistryDTO. The registry URI

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

nipyapi.nifi.models.relationship_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.relationship_dto.RelationshipDTO(name=None, description=None, auto_terminate=None)[source]

Bases: object

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

RelationshipDTO - a model defined in Swagger

attribute_map = {'auto_terminate': 'autoTerminate', 'description': 'description', 'name': 'name'}
auto_terminate

Gets the auto_terminate of this RelationshipDTO. Whether or not flowfiles sent to this relationship should auto terminate.

Returns:The auto_terminate of this RelationshipDTO.
Return type:bool
description

Gets the description of this RelationshipDTO. The relationship description.

Returns:The description of this RelationshipDTO.
Return type:str
name

Gets the name of this RelationshipDTO. The relationship name.

Returns:The name of this RelationshipDTO.
Return type:str
swagger_types = {'auto_terminate': 'bool', 'description': 'str', 'name': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.remote_process_group_contents_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_contents_dto.RemoteProcessGroupContentsDTO(input_ports=None, output_ports=None)[source]

Bases: object

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

RemoteProcessGroupContentsDTO - a model defined in Swagger

attribute_map = {'input_ports': 'inputPorts', 'output_ports': 'outputPorts'}
input_ports

Gets the input_ports of this RemoteProcessGroupContentsDTO. The input ports to which data can be sent.

Returns:The input_ports of this RemoteProcessGroupContentsDTO.
Return type:list[RemoteProcessGroupPortDTO]
output_ports

Gets the output_ports of this RemoteProcessGroupContentsDTO. The output ports from which data can be retrieved.

Returns:The output_ports of this RemoteProcessGroupContentsDTO.
Return type:list[RemoteProcessGroupPortDTO]
swagger_types = {'input_ports': 'list[RemoteProcessGroupPortDTO]', 'output_ports': 'list[RemoteProcessGroupPortDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_dto.RemoteProcessGroupDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, target_uri=None, target_uris=None, target_secure=None, name=None, comments=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, authorization_issues=None, validation_errors=None, transmitting=None, input_port_count=None, output_port_count=None, active_remote_input_port_count=None, inactive_remote_input_port_count=None, active_remote_output_port_count=None, inactive_remote_output_port_count=None, flow_refreshed=None, contents=None)[source]

Bases: object

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

RemoteProcessGroupDTO - a model defined in Swagger

active_remote_input_port_count

Gets the active_remote_input_port_count of this RemoteProcessGroupDTO. The number of active remote input ports.

Returns:The active_remote_input_port_count of this RemoteProcessGroupDTO.
Return type:int
active_remote_output_port_count

Gets the active_remote_output_port_count of this RemoteProcessGroupDTO. The number of active remote output ports.

Returns:The active_remote_output_port_count of this RemoteProcessGroupDTO.
Return type:int
attribute_map = {'active_remote_input_port_count': 'activeRemoteInputPortCount', 'active_remote_output_port_count': 'activeRemoteOutputPortCount', 'authorization_issues': 'authorizationIssues', 'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'contents': 'contents', 'flow_refreshed': 'flowRefreshed', 'id': 'id', 'inactive_remote_input_port_count': 'inactiveRemoteInputPortCount', 'inactive_remote_output_port_count': 'inactiveRemoteOutputPortCount', 'input_port_count': 'inputPortCount', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_port_count': 'outputPortCount', 'parent_group_id': 'parentGroupId', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_password': 'proxyPassword', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_secure': 'targetSecure', 'target_uri': 'targetUri', 'target_uris': 'targetUris', 'transmitting': 'transmitting', 'transport_protocol': 'transportProtocol', 'validation_errors': 'validationErrors', 'versioned_component_id': 'versionedComponentId', 'yield_duration': 'yieldDuration'}
authorization_issues

Gets the authorization_issues of this RemoteProcessGroupDTO. Any remote authorization issues for the remote process group.

Returns:The authorization_issues of this RemoteProcessGroupDTO.
Return type:list[str]
comments

Gets the comments of this RemoteProcessGroupDTO. The comments for the remote process group.

Returns:The comments of this RemoteProcessGroupDTO.
Return type:str
communications_timeout

Gets the communications_timeout of this RemoteProcessGroupDTO. The time period used for the timeout when communicating with the target.

Returns:The communications_timeout of this RemoteProcessGroupDTO.
Return type:str
contents

Gets the contents of this RemoteProcessGroupDTO. The contents of the remote process group. Will contain available input/output ports.

Returns:The contents of this RemoteProcessGroupDTO.
Return type:RemoteProcessGroupContentsDTO
flow_refreshed

Gets the flow_refreshed of this RemoteProcessGroupDTO. The timestamp when this remote process group was last refreshed.

Returns:The flow_refreshed of this RemoteProcessGroupDTO.
Return type:str
id

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

Returns:The id of this RemoteProcessGroupDTO.
Return type:str
inactive_remote_input_port_count

Gets the inactive_remote_input_port_count of this RemoteProcessGroupDTO. The number of inactive remote input ports.

Returns:The inactive_remote_input_port_count of this RemoteProcessGroupDTO.
Return type:int
inactive_remote_output_port_count

Gets the inactive_remote_output_port_count of this RemoteProcessGroupDTO. The number of inactive remote output ports.

Returns:The inactive_remote_output_port_count of this RemoteProcessGroupDTO.
Return type:int
input_port_count

Gets the input_port_count of this RemoteProcessGroupDTO. The number of remote input ports currently available on the target.

Returns:The input_port_count of this RemoteProcessGroupDTO.
Return type:int
local_network_interface

Gets the local_network_interface of this RemoteProcessGroupDTO. The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.

Returns:The local_network_interface of this RemoteProcessGroupDTO.
Return type:str
name

Gets the name of this RemoteProcessGroupDTO. The name of the remote process group.

Returns:The name of this RemoteProcessGroupDTO.
Return type:str
output_port_count

Gets the output_port_count of this RemoteProcessGroupDTO. The number of remote output ports currently available on the target.

Returns:The output_port_count of this RemoteProcessGroupDTO.
Return type:int
parent_group_id

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

Returns:The parent_group_id of this RemoteProcessGroupDTO.
Return type:str
position

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

Returns:The position of this RemoteProcessGroupDTO.
Return type:PositionDTO
proxy_host

Gets the proxy_host of this RemoteProcessGroupDTO.

Returns:The proxy_host of this RemoteProcessGroupDTO.
Return type:str
proxy_password

Gets the proxy_password of this RemoteProcessGroupDTO.

Returns:The proxy_password of this RemoteProcessGroupDTO.
Return type:str
proxy_port

Gets the proxy_port of this RemoteProcessGroupDTO.

Returns:The proxy_port of this RemoteProcessGroupDTO.
Return type:int
proxy_user

Gets the proxy_user of this RemoteProcessGroupDTO.

Returns:The proxy_user of this RemoteProcessGroupDTO.
Return type:str
swagger_types = {'active_remote_input_port_count': 'int', 'active_remote_output_port_count': 'int', 'authorization_issues': 'list[str]', 'comments': 'str', 'communications_timeout': 'str', 'contents': 'RemoteProcessGroupContentsDTO', 'flow_refreshed': 'str', 'id': 'str', 'inactive_remote_input_port_count': 'int', 'inactive_remote_output_port_count': 'int', 'input_port_count': 'int', 'local_network_interface': 'str', 'name': 'str', 'output_port_count': 'int', 'parent_group_id': 'str', 'position': 'PositionDTO', 'proxy_host': 'str', 'proxy_password': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_secure': 'bool', 'target_uri': 'str', 'target_uris': 'str', 'transmitting': 'bool', 'transport_protocol': 'str', 'validation_errors': 'list[str]', 'versioned_component_id': 'str', 'yield_duration': 'str'}
target_secure

Gets the target_secure of this RemoteProcessGroupDTO. Whether the target is running securely.

Returns:The target_secure of this RemoteProcessGroupDTO.
Return type:bool
target_uri

Gets the target_uri of this RemoteProcessGroupDTO. The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null.

Returns:The target_uri of this RemoteProcessGroupDTO.
Return type:str
target_uris

Gets the target_uris of this RemoteProcessGroupDTO. The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null.

Returns:The target_uris of this RemoteProcessGroupDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmitting

Gets the transmitting of this RemoteProcessGroupDTO. Whether the remote process group is actively transmitting.

Returns:The transmitting of this RemoteProcessGroupDTO.
Return type:bool
transport_protocol

Gets the transport_protocol of this RemoteProcessGroupDTO.

Returns:The transport_protocol of this RemoteProcessGroupDTO.
Return type:str
validation_errors

Gets the validation_errors of this RemoteProcessGroupDTO. The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.

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

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

Returns:The versioned_component_id of this RemoteProcessGroupDTO.
Return type:str
yield_duration

Gets the yield_duration of this RemoteProcessGroupDTO. When yielding, this amount of time must elapse before the remote process group is scheduled again.

Returns:The yield_duration of this RemoteProcessGroupDTO.
Return type:str

nipyapi.nifi.models.remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_entity.RemoteProcessGroupEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, status=None, input_port_count=None, output_port_count=None, operate_permissions=None)[source]

Bases: object

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

RemoteProcessGroupEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'input_port_count': 'inputPortCount', 'operate_permissions': 'operatePermissions', 'output_port_count': 'outputPortCount', 'permissions': 'permissions', 'position': 'position', 'revision': 'revision', 'status': 'status', 'uri': 'uri'}
bulletins

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

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

Gets the component of this RemoteProcessGroupEntity.

Returns:The component of this RemoteProcessGroupEntity.
Return type:RemoteProcessGroupDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this RemoteProcessGroupEntity.
Return type:bool
id

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

Returns:The id of this RemoteProcessGroupEntity.
Return type:str
input_port_count

Gets the input_port_count of this RemoteProcessGroupEntity. The number of remote input ports currently available on the target.

Returns:The input_port_count of this RemoteProcessGroupEntity.
Return type:int
operate_permissions

Gets the operate_permissions of this RemoteProcessGroupEntity. The permissions for this component operations.

Returns:The operate_permissions of this RemoteProcessGroupEntity.
Return type:PermissionsDTO
output_port_count

Gets the output_port_count of this RemoteProcessGroupEntity. The number of remote output ports currently available on the target.

Returns:The output_port_count of this RemoteProcessGroupEntity.
Return type:int
permissions

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

Returns:The permissions of this RemoteProcessGroupEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this RemoteProcessGroupEntity.
Return type:PositionDTO
revision

Gets the revision of this RemoteProcessGroupEntity. 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 RemoteProcessGroupEntity.
Return type:RevisionDTO
status

Gets the status of this RemoteProcessGroupEntity. The status of the remote process group.

Returns:The status of this RemoteProcessGroupEntity.
Return type:RemoteProcessGroupStatusDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'RemoteProcessGroupDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'input_port_count': 'int', 'operate_permissions': 'PermissionsDTO', 'output_port_count': 'int', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'RemoteProcessGroupStatusDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.remote_process_group_port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_port_dto.RemoteProcessGroupPortDTO(id=None, target_id=None, versioned_component_id=None, group_id=None, name=None, comments=None, concurrently_schedulable_task_count=None, transmitting=None, use_compression=None, exists=None, target_running=None, connected=None, batch_settings=None)[source]

Bases: object

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

RemoteProcessGroupPortDTO - a model defined in Swagger

attribute_map = {'batch_settings': 'batchSettings', 'comments': 'comments', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'connected': 'connected', 'exists': 'exists', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'target_id': 'targetId', 'target_running': 'targetRunning', 'transmitting': 'transmitting', 'use_compression': 'useCompression', 'versioned_component_id': 'versionedComponentId'}
batch_settings

Gets the batch_settings of this RemoteProcessGroupPortDTO. The batch settings for data transmission.

Returns:The batch_settings of this RemoteProcessGroupPortDTO.
Return type:BatchSettingsDTO
comments

Gets the comments of this RemoteProcessGroupPortDTO. The comments as configured on the target port.

Returns:The comments of this RemoteProcessGroupPortDTO.
Return type:str
concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO. The number of task that may transmit flowfiles to the target port concurrently.

Returns:The concurrently_schedulable_task_count of this RemoteProcessGroupPortDTO.
Return type:int
connected

Gets the connected of this RemoteProcessGroupPortDTO. Whether the port has either an incoming or outgoing connection.

Returns:The connected of this RemoteProcessGroupPortDTO.
Return type:bool
exists

Gets the exists of this RemoteProcessGroupPortDTO. Whether the target port exists.

Returns:The exists of this RemoteProcessGroupPortDTO.
Return type:bool
group_id

Gets the group_id of this RemoteProcessGroupPortDTO. The id of the remote process group that the port resides in.

Returns:The group_id of this RemoteProcessGroupPortDTO.
Return type:str
id

Gets the id of this RemoteProcessGroupPortDTO. The id of the port.

Returns:The id of this RemoteProcessGroupPortDTO.
Return type:str
name

Gets the name of this RemoteProcessGroupPortDTO. The name of the target port.

Returns:The name of this RemoteProcessGroupPortDTO.
Return type:str
swagger_types = {'batch_settings': 'BatchSettingsDTO', 'comments': 'str', 'concurrently_schedulable_task_count': 'int', 'connected': 'bool', 'exists': 'bool', 'group_id': 'str', 'id': 'str', 'name': 'str', 'target_id': 'str', 'target_running': 'bool', 'transmitting': 'bool', 'use_compression': 'bool', 'versioned_component_id': 'str'}
target_id

Gets the target_id of this RemoteProcessGroupPortDTO. The id of the target port.

Returns:The target_id of this RemoteProcessGroupPortDTO.
Return type:str
target_running

Gets the target_running of this RemoteProcessGroupPortDTO. Whether the target port is running.

Returns:The target_running of this RemoteProcessGroupPortDTO.
Return type:bool
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmitting

Gets the transmitting of this RemoteProcessGroupPortDTO. Whether the remote port is configured for transmission.

Returns:The transmitting of this RemoteProcessGroupPortDTO.
Return type:bool
use_compression

Gets the use_compression of this RemoteProcessGroupPortDTO. Whether the flowfiles are compressed when sent to the target port.

Returns:The use_compression of this RemoteProcessGroupPortDTO.
Return type:bool
versioned_component_id

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

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

nipyapi.nifi.models.remote_process_group_port_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_port_entity.RemoteProcessGroupPortEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, remote_process_group_port=None, operate_permissions=None)[source]

Bases: object

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

RemoteProcessGroupPortEntity - a model defined in Swagger

attribute_map = {'bulletins': 'bulletins', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'operate_permissions': 'operatePermissions', 'permissions': 'permissions', 'position': 'position', 'remote_process_group_port': 'remoteProcessGroupPort', 'revision': 'revision', 'uri': 'uri'}
bulletins

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

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

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

Returns:The disconnected_node_acknowledged of this RemoteProcessGroupPortEntity.
Return type:bool
id

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

Returns:The id of this RemoteProcessGroupPortEntity.
Return type:str
operate_permissions

Gets the operate_permissions of this RemoteProcessGroupPortEntity. The permissions for this component operations.

Returns:The operate_permissions of this RemoteProcessGroupPortEntity.
Return type:PermissionsDTO
permissions

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

Returns:The permissions of this RemoteProcessGroupPortEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this RemoteProcessGroupPortEntity.
Return type:PositionDTO
remote_process_group_port

Gets the remote_process_group_port of this RemoteProcessGroupPortEntity.

Returns:The remote_process_group_port of this RemoteProcessGroupPortEntity.
Return type:RemoteProcessGroupPortDTO
revision

Gets the revision of this RemoteProcessGroupPortEntity. 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 RemoteProcessGroupPortEntity.
Return type:RevisionDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'remote_process_group_port': 'RemoteProcessGroupPortDTO', 'revision': 'RevisionDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_dto.RemoteProcessGroupStatusDTO(group_id=None, id=None, name=None, target_uri=None, transmission_status=None, stats_last_refreshed=None, validation_status=None, aggregate_snapshot=None, node_snapshots=None)[source]

Bases: object

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

RemoteProcessGroupStatusDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this RemoteProcessGroupStatusDTO. A status snapshot that represents the aggregate stats 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 RemoteProcessGroupStatusDTO.
Return type:RemoteProcessGroupStatusSnapshotDTO
attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'node_snapshots': 'nodeSnapshots', 'stats_last_refreshed': 'statsLastRefreshed', 'target_uri': 'targetUri', 'transmission_status': 'transmissionStatus', 'validation_status': 'validationStatus'}
group_id

Gets the group_id of this RemoteProcessGroupStatusDTO. The unique ID of the process group that the Processor belongs to

Returns:The group_id of this RemoteProcessGroupStatusDTO.
Return type:str
id

Gets the id of this RemoteProcessGroupStatusDTO. The unique ID of the Processor

Returns:The id of this RemoteProcessGroupStatusDTO.
Return type:str
name

Gets the name of this RemoteProcessGroupStatusDTO. The name of the remote process group.

Returns:The name of this RemoteProcessGroupStatusDTO.
Return type:str
node_snapshots

Gets the node_snapshots of this RemoteProcessGroupStatusDTO. A status 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 RemoteProcessGroupStatusDTO.
Return type:list[NodeRemoteProcessGroupStatusSnapshotDTO]
stats_last_refreshed

Gets the stats_last_refreshed of this RemoteProcessGroupStatusDTO. The time the status for the process group was last refreshed.

Returns:The stats_last_refreshed of this RemoteProcessGroupStatusDTO.
Return type:str
swagger_types = {'aggregate_snapshot': 'RemoteProcessGroupStatusSnapshotDTO', 'group_id': 'str', 'id': 'str', 'name': 'str', 'node_snapshots': 'list[NodeRemoteProcessGroupStatusSnapshotDTO]', 'stats_last_refreshed': 'str', 'target_uri': 'str', 'transmission_status': 'str', 'validation_status': 'str'}
target_uri

Gets the target_uri of this RemoteProcessGroupStatusDTO. The URI of the target system.

Returns:The target_uri of this RemoteProcessGroupStatusDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmission_status

Gets the transmission_status of this RemoteProcessGroupStatusDTO. The transmission status of the remote process group.

Returns:The transmission_status of this RemoteProcessGroupStatusDTO.
Return type:str
validation_status

Gets the validation_status of this RemoteProcessGroupStatusDTO. Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)

Returns:The validation_status of this RemoteProcessGroupStatusDTO.
Return type:str

nipyapi.nifi.models.remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_entity.RemoteProcessGroupStatusEntity(remote_process_group_status=None, can_read=None)[source]

Bases: object

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

RemoteProcessGroupStatusEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'remote_process_group_status': 'remoteProcessGroupStatus'}
can_read

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

Returns:The can_read of this RemoteProcessGroupStatusEntity.
Return type:bool
remote_process_group_status

Gets the remote_process_group_status of this RemoteProcessGroupStatusEntity.

Returns:The remote_process_group_status of this RemoteProcessGroupStatusEntity.
Return type:RemoteProcessGroupStatusDTO
swagger_types = {'can_read': 'bool', 'remote_process_group_status': 'RemoteProcessGroupStatusDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_snapshot_dto.RemoteProcessGroupStatusSnapshotDTO(id=None, group_id=None, name=None, target_uri=None, transmission_status=None, active_thread_count=None, flow_files_sent=None, bytes_sent=None, sent=None, flow_files_received=None, bytes_received=None, received=None)[source]

Bases: object

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

RemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this RemoteProcessGroupStatusSnapshotDTO. The number of active threads for the remote process group.

Returns:The active_thread_count of this RemoteProcessGroupStatusSnapshotDTO.
Return type:int
attribute_map = {'active_thread_count': 'activeThreadCount', 'bytes_received': 'bytesReceived', 'bytes_sent': 'bytesSent', 'flow_files_received': 'flowFilesReceived', 'flow_files_sent': 'flowFilesSent', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'received': 'received', 'sent': 'sent', 'target_uri': 'targetUri', 'transmission_status': 'transmissionStatus'}
bytes_received

Gets the bytes_received of this RemoteProcessGroupStatusSnapshotDTO. The size of the FlowFiles received from the remote process group in the last 5 minutes.

Returns:The bytes_received of this RemoteProcessGroupStatusSnapshotDTO.
Return type:int
bytes_sent

Gets the bytes_sent of this RemoteProcessGroupStatusSnapshotDTO. The size of the FlowFiles sent to the remote process group in the last 5 minutes.

Returns:The bytes_sent of this RemoteProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_received

Gets the flow_files_received of this RemoteProcessGroupStatusSnapshotDTO. The number of FlowFiles received from the remote process group in the last 5 minutes.

Returns:The flow_files_received of this RemoteProcessGroupStatusSnapshotDTO.
Return type:int
flow_files_sent

Gets the flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO. The number of FlowFiles sent to the remote process group in the last 5 minutes.

Returns:The flow_files_sent of this RemoteProcessGroupStatusSnapshotDTO.
Return type:int
group_id

Gets the group_id of this RemoteProcessGroupStatusSnapshotDTO. The id of the parent process group the remote process group resides in.

Returns:The group_id of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str
id

Gets the id of this RemoteProcessGroupStatusSnapshotDTO. The id of the remote process group.

Returns:The id of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str
name

Gets the name of this RemoteProcessGroupStatusSnapshotDTO. The name of the remote process group.

Returns:The name of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str
received

Gets the received of this RemoteProcessGroupStatusSnapshotDTO. The count/size of the flowfiles received from the remote process group in the last 5 minutes.

Returns:The received of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str
sent

Gets the sent of this RemoteProcessGroupStatusSnapshotDTO. The count/size of the flowfiles sent to the remote process group in the last 5 minutes.

Returns:The sent of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str
swagger_types = {'active_thread_count': 'int', 'bytes_received': 'int', 'bytes_sent': 'int', 'flow_files_received': 'int', 'flow_files_sent': 'int', 'group_id': 'str', 'id': 'str', 'name': 'str', 'received': 'str', 'sent': 'str', 'target_uri': 'str', 'transmission_status': 'str'}
target_uri

Gets the target_uri of this RemoteProcessGroupStatusSnapshotDTO. The URI of the target system.

Returns:The target_uri of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transmission_status

Gets the transmission_status of this RemoteProcessGroupStatusSnapshotDTO. The transmission status of the remote process group.

Returns:The transmission_status of this RemoteProcessGroupStatusSnapshotDTO.
Return type:str

nipyapi.nifi.models.remote_process_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_group_status_snapshot_entity.RemoteProcessGroupStatusSnapshotEntity(id=None, remote_process_group_status_snapshot=None, can_read=None)[source]

Bases: object

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

RemoteProcessGroupStatusSnapshotEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'id': 'id', 'remote_process_group_status_snapshot': 'remoteProcessGroupStatusSnapshot'}
can_read

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

Returns:The can_read of this RemoteProcessGroupStatusSnapshotEntity.
Return type:bool
id

Gets the id of this RemoteProcessGroupStatusSnapshotEntity. The id of the remote process group.

Returns:The id of this RemoteProcessGroupStatusSnapshotEntity.
Return type:str
remote_process_group_status_snapshot

Gets the remote_process_group_status_snapshot of this RemoteProcessGroupStatusSnapshotEntity.

Returns:The remote_process_group_status_snapshot of this RemoteProcessGroupStatusSnapshotEntity.
Return type:RemoteProcessGroupStatusSnapshotDTO
swagger_types = {'can_read': 'bool', 'id': 'str', 'remote_process_group_status_snapshot': 'RemoteProcessGroupStatusSnapshotDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.remote_process_groups_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.remote_process_groups_entity.RemoteProcessGroupsEntity(remote_process_groups=None)[source]

Bases: object

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

RemoteProcessGroupsEntity - a model defined in Swagger

attribute_map = {'remote_process_groups': 'remoteProcessGroups'}
remote_process_groups

Gets the remote_process_groups of this RemoteProcessGroupsEntity.

Returns:The remote_process_groups of this RemoteProcessGroupsEntity.
Return type:list[RemoteProcessGroupEntity]
swagger_types = {'remote_process_groups': 'list[RemoteProcessGroupEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.reporting_task_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_task_dto.ReportingTaskDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, name=None, type=None, bundle=None, state=None, comments=None, persists_state=None, restricted=None, deprecated=None, multiple_versions_available=None, scheduling_period=None, scheduling_strategy=None, default_scheduling_period=None, properties=None, descriptors=None, custom_ui_url=None, annotation_data=None, validation_errors=None, validation_status=None, active_thread_count=None, extension_missing=None)[source]

Bases: object

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

ReportingTaskDTO - a model defined in Swagger

active_thread_count

Gets the active_thread_count of this ReportingTaskDTO. The number of active threads for the reporting task.

Returns:The active_thread_count of this ReportingTaskDTO.
Return type:int
annotation_data

Gets the annotation_data of this ReportingTaskDTO. The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.

Returns:The annotation_data of this ReportingTaskDTO.
Return type:str
attribute_map = {'active_thread_count': 'activeThreadCount', 'annotation_data': 'annotationData', 'bundle': 'bundle', 'comments': 'comments', 'custom_ui_url': 'customUiUrl', 'default_scheduling_period': 'defaultSchedulingPeriod', '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', 'restricted': 'restricted', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'state': 'state', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}
bundle

Gets the bundle of this ReportingTaskDTO. The details of the artifact that bundled this processor type.

Returns:The bundle of this ReportingTaskDTO.
Return type:BundleDTO
comments

Gets the comments of this ReportingTaskDTO. The comments of the reporting task.

Returns:The comments of this ReportingTaskDTO.
Return type:str
custom_ui_url

Gets the custom_ui_url of this ReportingTaskDTO. The URL for the custom configuration UI for the reporting task.

Returns:The custom_ui_url of this ReportingTaskDTO.
Return type:str
default_scheduling_period

Gets the default_scheduling_period of this ReportingTaskDTO. The default scheduling period for the different scheduling strategies.

Returns:The default_scheduling_period of this ReportingTaskDTO.
Return type:dict(str, str)
deprecated

Gets the deprecated of this ReportingTaskDTO. Whether the reporting task has been deprecated.

Returns:The deprecated of this ReportingTaskDTO.
Return type:bool
descriptors

Gets the descriptors of this ReportingTaskDTO. The descriptors for the reporting tasks properties.

Returns:The descriptors of this ReportingTaskDTO.
Return type:dict(str, PropertyDescriptorDTO)
extension_missing

Gets the extension_missing of this ReportingTaskDTO. Whether the underlying extension is missing.

Returns:The extension_missing of this ReportingTaskDTO.
Return type:bool
id

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

Returns:The id of this ReportingTaskDTO.
Return type:str
multiple_versions_available

Gets the multiple_versions_available of this ReportingTaskDTO. Whether the reporting task has multiple versions available.

Returns:The multiple_versions_available of this ReportingTaskDTO.
Return type:bool
name

Gets the name of this ReportingTaskDTO. The name of the reporting task.

Returns:The name of this ReportingTaskDTO.
Return type:str
parent_group_id

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

Returns:The parent_group_id of this ReportingTaskDTO.
Return type:str
persists_state

Gets the persists_state of this ReportingTaskDTO. Whether the reporting task persists state.

Returns:The persists_state of this ReportingTaskDTO.
Return type:bool
position

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

Returns:The position of this ReportingTaskDTO.
Return type:PositionDTO
properties

Gets the properties of this ReportingTaskDTO. The properties of the reporting task.

Returns:The properties of this ReportingTaskDTO.
Return type:dict(str, str)
restricted

Gets the restricted of this ReportingTaskDTO. Whether the reporting task requires elevated privileges.

Returns:The restricted of this ReportingTaskDTO.
Return type:bool
scheduling_period

Gets the scheduling_period of this ReportingTaskDTO. The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy.

Returns:The scheduling_period of this ReportingTaskDTO.
Return type:str
scheduling_strategy

Gets the scheduling_strategy of this ReportingTaskDTO. The scheduling strategy that determines how the schedulingPeriod value should be interpreted.

Returns:The scheduling_strategy of this ReportingTaskDTO.
Return type:str
state

Gets the state of this ReportingTaskDTO. The state of the reporting task.

Returns:The state of this ReportingTaskDTO.
Return type:str
swagger_types = {'active_thread_count': 'int', 'annotation_data': 'str', 'bundle': 'BundleDTO', 'comments': 'str', 'custom_ui_url': 'str', 'default_scheduling_period': 'dict(str, 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)', 'restricted': 'bool', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'state': 'str', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this ReportingTaskDTO. The fully qualified type of the reporting task.

Returns:The type of this ReportingTaskDTO.
Return type:str
validation_errors

Gets the validation_errors of this ReportingTaskDTO. Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.

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

Gets the validation_status of this ReportingTaskDTO. Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)

Returns:The validation_status of this ReportingTaskDTO.
Return type:str
versioned_component_id

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

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

nipyapi.nifi.models.reporting_task_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_task_entity.ReportingTaskEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None, operate_permissions=None, status=None)[source]

Bases: object

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

ReportingTaskEntity - 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', 'status': 'status', 'uri': 'uri'}
bulletins

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

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

Gets the component of this ReportingTaskEntity.

Returns:The component of this ReportingTaskEntity.
Return type:ReportingTaskDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this ReportingTaskEntity.
Return type:bool
id

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

Returns:The id of this ReportingTaskEntity.
Return type:str
operate_permissions

Gets the operate_permissions of this ReportingTaskEntity. The permissions for this component operations.

Returns:The operate_permissions of this ReportingTaskEntity.
Return type:PermissionsDTO
permissions

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

Returns:The permissions of this ReportingTaskEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this ReportingTaskEntity.
Return type:PositionDTO
revision

Gets the revision of this ReportingTaskEntity. 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 ReportingTaskEntity.
Return type:RevisionDTO
status

Gets the status of this ReportingTaskEntity. The status for this ReportingTask.

Returns:The status of this ReportingTaskEntity.
Return type:ReportingTaskStatusDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'ReportingTaskDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'operate_permissions': 'PermissionsDTO', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'status': 'ReportingTaskStatusDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.reporting_task_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_task_types_entity.ReportingTaskTypesEntity(reporting_task_types=None)[source]

Bases: object

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

ReportingTaskTypesEntity - a model defined in Swagger

attribute_map = {'reporting_task_types': 'reportingTaskTypes'}
reporting_task_types

Gets the reporting_task_types of this ReportingTaskTypesEntity.

Returns:The reporting_task_types of this ReportingTaskTypesEntity.
Return type:list[DocumentedTypeDTO]
swagger_types = {'reporting_task_types': 'list[DocumentedTypeDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.reporting_tasks_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.reporting_tasks_entity.ReportingTasksEntity(reporting_tasks=None)[source]

Bases: object

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

ReportingTasksEntity - a model defined in Swagger

attribute_map = {'reporting_tasks': 'reportingTasks'}
reporting_tasks

Gets the reporting_tasks of this ReportingTasksEntity.

Returns:The reporting_tasks of this ReportingTasksEntity.
Return type:list[ReportingTaskEntity]
swagger_types = {'reporting_tasks': 'list[ReportingTaskEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.resource_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.resource_dto.ResourceDTO(identifier=None, name=None)[source]

Bases: object

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

ResourceDTO - a model defined in Swagger

attribute_map = {'identifier': 'identifier', 'name': 'name'}
identifier

Gets the identifier of this ResourceDTO. The identifier of the resource.

Returns:The identifier of this ResourceDTO.
Return type:str
name

Gets the name of this ResourceDTO. The name of the resource.

Returns:The name of this ResourceDTO.
Return type:str
swagger_types = {'identifier': 'str', 'name': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.resources_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.resources_entity.ResourcesEntity(resources=None)[source]

Bases: object

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

ResourcesEntity - a model defined in Swagger

attribute_map = {'resources': 'resources'}
resources

Gets the resources of this ResourcesEntity.

Returns:The resources of this ResourcesEntity.
Return type:list[ResourceDTO]
swagger_types = {'resources': 'list[ResourceDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.revision_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.revision_dto.RevisionDTO(client_id=None, version=None, last_modifier=None)[source]

Bases: object

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

RevisionDTO - a model defined in Swagger

attribute_map = {'client_id': 'clientId', 'last_modifier': 'lastModifier', 'version': 'version'}
client_id

Gets the client_id of this RevisionDTO. A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back

Returns:The client_id of this RevisionDTO.
Return type:str
last_modifier

Gets the last_modifier of this RevisionDTO. The user that last modified the flow.

Returns:The last_modifier of this RevisionDTO.
Return type:str
swagger_types = {'client_id': 'str', 'last_modifier': 'str', 'version': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

version

Gets the version of this RevisionDTO. NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version.

Returns:The version of this RevisionDTO.
Return type:int

nipyapi.nifi.models.schedule_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.schedule_components_entity.ScheduleComponentsEntity(id=None, state=None, components=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

ScheduleComponentsEntity - a model defined in Swagger

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

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

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

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

Returns:The disconnected_node_acknowledged of this ScheduleComponentsEntity.
Return type:bool
id

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

Returns:The id of this ScheduleComponentsEntity.
Return type:str
state

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

Returns:The state of this ScheduleComponentsEntity.
Return type:str
swagger_types = {'components': 'dict(str, RevisionDTO)', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'state': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.search_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.search_results_dto.SearchResultsDTO(processor_results=None, connection_results=None, process_group_results=None, input_port_results=None, output_port_results=None, remote_process_group_results=None, funnel_results=None, parameter_context_results=None, parameter_results=None)[source]

Bases: object

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

SearchResultsDTO - a model defined in Swagger

attribute_map = {'connection_results': 'connectionResults', 'funnel_results': 'funnelResults', 'input_port_results': 'inputPortResults', 'output_port_results': 'outputPortResults', 'parameter_context_results': 'parameterContextResults', 'parameter_results': 'parameterResults', 'process_group_results': 'processGroupResults', 'processor_results': 'processorResults', 'remote_process_group_results': 'remoteProcessGroupResults'}
connection_results

Gets the connection_results of this SearchResultsDTO. The connections that matched the search.

Returns:The connection_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
funnel_results

Gets the funnel_results of this SearchResultsDTO. The funnels that matched the search.

Returns:The funnel_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
input_port_results

Gets the input_port_results of this SearchResultsDTO. The input ports that matched the search.

Returns:The input_port_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
output_port_results

Gets the output_port_results of this SearchResultsDTO. The output ports that matched the search.

Returns:The output_port_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
parameter_context_results

Gets the parameter_context_results of this SearchResultsDTO. The parameter contexts that matched the search.

Returns:The parameter_context_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
parameter_results

Gets the parameter_results of this SearchResultsDTO. The parameters that matched the search.

Returns:The parameter_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
process_group_results

Gets the process_group_results of this SearchResultsDTO. The process groups that matched the search.

Returns:The process_group_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
processor_results

Gets the processor_results of this SearchResultsDTO. The processors that matched the search.

Returns:The processor_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
remote_process_group_results

Gets the remote_process_group_results of this SearchResultsDTO. The remote process groups that matched the search.

Returns:The remote_process_group_results of this SearchResultsDTO.
Return type:list[ComponentSearchResultDTO]
swagger_types = {'connection_results': 'list[ComponentSearchResultDTO]', 'funnel_results': 'list[ComponentSearchResultDTO]', 'input_port_results': 'list[ComponentSearchResultDTO]', 'output_port_results': 'list[ComponentSearchResultDTO]', 'parameter_context_results': 'list[ComponentSearchResultDTO]', 'parameter_results': 'list[ComponentSearchResultDTO]', 'process_group_results': 'list[ComponentSearchResultDTO]', 'processor_results': 'list[ComponentSearchResultDTO]', 'remote_process_group_results': 'list[ComponentSearchResultDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.search_results_entity.SearchResultsEntity(search_results_dto=None)[source]

Bases: object

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

SearchResultsEntity - a model defined in Swagger

attribute_map = {'search_results_dto': 'searchResultsDTO'}
search_results_dto

Gets the search_results_dto of this SearchResultsEntity.

Returns:The search_results_dto of this SearchResultsEntity.
Return type:SearchResultsDTO
swagger_types = {'search_results_dto': 'SearchResultsDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.snippet_dto.SnippetDTO(id=None, uri=None, parent_group_id=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None)[source]

Bases: object

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

SnippetDTO - a model defined in Swagger

attribute_map = {'connections': 'connections', 'funnels': 'funnels', 'id': 'id', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'parent_group_id': 'parentGroupId', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'uri': 'uri'}
connections

Gets the connections of this SnippetDTO. The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The connections of this SnippetDTO.
Return type:dict(str, RevisionDTO)
funnels

Gets the funnels of this SnippetDTO. The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The funnels of this SnippetDTO.
Return type:dict(str, RevisionDTO)
id

Gets the id of this SnippetDTO. The id of the snippet.

Returns:The id of this SnippetDTO.
Return type:str
input_ports

Gets the input_ports of this SnippetDTO. The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The input_ports of this SnippetDTO.
Return type:dict(str, RevisionDTO)
labels

Gets the labels of this SnippetDTO. The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The labels of this SnippetDTO.
Return type:dict(str, RevisionDTO)
output_ports

Gets the output_ports of this SnippetDTO. The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The output_ports of this SnippetDTO.
Return type:dict(str, RevisionDTO)
parent_group_id

Gets the parent_group_id of this SnippetDTO. The group id for the components in the snippet.

Returns:The parent_group_id of this SnippetDTO.
Return type:str
process_groups

Gets the process_groups of this SnippetDTO. The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The process_groups of this SnippetDTO.
Return type:dict(str, RevisionDTO)
processors

Gets the processors of this SnippetDTO. The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The processors of this SnippetDTO.
Return type:dict(str, RevisionDTO)
remote_process_groups

Gets the remote_process_groups of this SnippetDTO. The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Returns:The remote_process_groups of this SnippetDTO.
Return type:dict(str, RevisionDTO)
swagger_types = {'connections': 'dict(str, RevisionDTO)', 'funnels': 'dict(str, RevisionDTO)', 'id': 'str', 'input_ports': 'dict(str, RevisionDTO)', 'labels': 'dict(str, RevisionDTO)', 'output_ports': 'dict(str, RevisionDTO)', 'parent_group_id': 'str', 'process_groups': 'dict(str, RevisionDTO)', 'processors': 'dict(str, RevisionDTO)', 'remote_process_groups': 'dict(str, RevisionDTO)', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

Gets the uri of this SnippetDTO. The URI of the snippet.

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

nipyapi.nifi.models.snippet_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.snippet_entity.SnippetEntity(snippet=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

SnippetEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'snippet': 'snippet'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this SnippetEntity.
Return type:bool
snippet

Gets the snippet of this SnippetEntity. The snippet.

Returns:The snippet of this SnippetEntity.
Return type:SnippetDTO
swagger_types = {'disconnected_node_acknowledged': 'bool', 'snippet': 'SnippetDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.start_version_control_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.start_version_control_request_entity.StartVersionControlRequestEntity(versioned_flow=None, process_group_revision=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

StartVersionControlRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'versioned_flow': 'versionedFlow'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this StartVersionControlRequestEntity.
Return type:bool
process_group_revision

Gets the process_group_revision of this StartVersionControlRequestEntity. The Revision of the Process Group under Version Control

Returns:The process_group_revision of this StartVersionControlRequestEntity.
Return type:RevisionDTO
swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'versioned_flow': 'VersionedFlowDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

versioned_flow

Gets the versioned_flow of this StartVersionControlRequestEntity. The versioned flow

Returns:The versioned_flow of this StartVersionControlRequestEntity.
Return type:VersionedFlowDTO

nipyapi.nifi.models.state_entry_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.state_entry_dto.StateEntryDTO(key=None, value=None, cluster_node_id=None, cluster_node_address=None)[source]

Bases: object

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

StateEntryDTO - a model defined in Swagger

attribute_map = {'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'key': 'key', 'value': 'value'}
cluster_node_address

Gets the cluster_node_address of this StateEntryDTO. The label for the node where the state originated.

Returns:The cluster_node_address of this StateEntryDTO.
Return type:str
cluster_node_id

Gets the cluster_node_id of this StateEntryDTO. The identifier for the node where the state originated.

Returns:The cluster_node_id of this StateEntryDTO.
Return type:str
key

Gets the key of this StateEntryDTO. The key for this state.

Returns:The key of this StateEntryDTO.
Return type:str
swagger_types = {'cluster_node_address': 'str', 'cluster_node_id': 'str', 'key': 'str', 'value': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

value

Gets the value of this StateEntryDTO. The value for this state.

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

nipyapi.nifi.models.state_map_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.state_map_dto.StateMapDTO(scope=None, total_entry_count=None, state=None)[source]

Bases: object

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

StateMapDTO - a model defined in Swagger

attribute_map = {'scope': 'scope', 'state': 'state', 'total_entry_count': 'totalEntryCount'}
scope

Gets the scope of this StateMapDTO. The scope of this StateMap.

Returns:The scope of this StateMapDTO.
Return type:str
state

Gets the state of this StateMapDTO. The state.

Returns:The state of this StateMapDTO.
Return type:list[StateEntryDTO]
swagger_types = {'scope': 'str', 'state': 'list[StateEntryDTO]', 'total_entry_count': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

total_entry_count

Gets the total_entry_count of this StateMapDTO. The total number of state entries. When the state map is lengthy, only of portion of the entries are returned.

Returns:The total_entry_count of this StateMapDTO.
Return type:int

nipyapi.nifi.models.status_descriptor_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_descriptor_dto.StatusDescriptorDTO(field=None, label=None, description=None, formatter=None)[source]

Bases: object

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

StatusDescriptorDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'field': 'field', 'formatter': 'formatter', 'label': 'label'}
description

Gets the description of this StatusDescriptorDTO. The description of the status field.

Returns:The description of this StatusDescriptorDTO.
Return type:str
field

Gets the field of this StatusDescriptorDTO. The name of the status field.

Returns:The field of this StatusDescriptorDTO.
Return type:str
formatter

Gets the formatter of this StatusDescriptorDTO. The formatter for the status descriptor.

Returns:The formatter of this StatusDescriptorDTO.
Return type:str
label

Gets the label of this StatusDescriptorDTO. The label for the status field.

Returns:The label of this StatusDescriptorDTO.
Return type:str
swagger_types = {'description': 'str', 'field': 'str', 'formatter': 'str', 'label': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.status_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_history_dto.StatusHistoryDTO(generated=None, component_details=None, field_descriptors=None, aggregate_snapshots=None, node_snapshots=None)[source]

Bases: object

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

StatusHistoryDTO - a model defined in Swagger

aggregate_snapshots

Gets the aggregate_snapshots of this StatusHistoryDTO. A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.

Returns:The aggregate_snapshots of this StatusHistoryDTO.
Return type:list[StatusSnapshotDTO]
attribute_map = {'aggregate_snapshots': 'aggregateSnapshots', 'component_details': 'componentDetails', 'field_descriptors': 'fieldDescriptors', 'generated': 'generated', 'node_snapshots': 'nodeSnapshots'}
component_details

Gets the component_details of this StatusHistoryDTO. A Map of key/value pairs that describe the component that the status history belongs to

Returns:The component_details of this StatusHistoryDTO.
Return type:dict(str, str)
field_descriptors

Gets the field_descriptors of this StatusHistoryDTO. The Descriptors that provide information on each of the metrics provided in the status history

Returns:The field_descriptors of this StatusHistoryDTO.
Return type:list[StatusDescriptorDTO]
generated

Gets the generated of this StatusHistoryDTO. When the status history was generated.

Returns:The generated of this StatusHistoryDTO.
Return type:str
node_snapshots

Gets the node_snapshots of this StatusHistoryDTO. The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.

Returns:The node_snapshots of this StatusHistoryDTO.
Return type:list[NodeStatusSnapshotsDTO]
swagger_types = {'aggregate_snapshots': 'list[StatusSnapshotDTO]', 'component_details': 'dict(str, str)', 'field_descriptors': 'list[StatusDescriptorDTO]', 'generated': 'str', 'node_snapshots': 'list[NodeStatusSnapshotsDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.status_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_history_entity.StatusHistoryEntity(status_history=None, can_read=None)[source]

Bases: object

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

StatusHistoryEntity - a model defined in Swagger

attribute_map = {'can_read': 'canRead', 'status_history': 'statusHistory'}
can_read

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

Returns:The can_read of this StatusHistoryEntity.
Return type:bool
status_history

Gets the status_history of this StatusHistoryEntity.

Returns:The status_history of this StatusHistoryEntity.
Return type:StatusHistoryDTO
swagger_types = {'can_read': 'bool', 'status_history': 'StatusHistoryDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.status_snapshot_dto.StatusSnapshotDTO(timestamp=None, status_metrics=None)[source]

Bases: object

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

StatusSnapshotDTO - a model defined in Swagger

attribute_map = {'status_metrics': 'statusMetrics', 'timestamp': 'timestamp'}
status_metrics

Gets the status_metrics of this StatusSnapshotDTO. The status metrics.

Returns:The status_metrics of this StatusSnapshotDTO.
Return type:dict(str, int)
swagger_types = {'status_metrics': 'dict(str, int)', 'timestamp': 'datetime'}
timestamp

Gets the timestamp of this StatusSnapshotDTO. The timestamp of the snapshot.

Returns:The timestamp of this StatusSnapshotDTO.
Return type:datetime
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.storage_usage_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.storage_usage_dto.StorageUsageDTO(identifier=None, free_space=None, total_space=None, used_space=None, free_space_bytes=None, total_space_bytes=None, used_space_bytes=None, utilization=None)[source]

Bases: object

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

StorageUsageDTO - a model defined in Swagger

attribute_map = {'free_space': 'freeSpace', 'free_space_bytes': 'freeSpaceBytes', 'identifier': 'identifier', 'total_space': 'totalSpace', 'total_space_bytes': 'totalSpaceBytes', 'used_space': 'usedSpace', 'used_space_bytes': 'usedSpaceBytes', 'utilization': 'utilization'}
free_space

Gets the free_space of this StorageUsageDTO. Amount of free space.

Returns:The free_space of this StorageUsageDTO.
Return type:str
free_space_bytes

Gets the free_space_bytes of this StorageUsageDTO. The number of bytes of free space.

Returns:The free_space_bytes of this StorageUsageDTO.
Return type:int
identifier

Gets the identifier of this StorageUsageDTO. The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration.

Returns:The identifier of this StorageUsageDTO.
Return type:str
swagger_types = {'free_space': 'str', 'free_space_bytes': 'int', 'identifier': 'str', 'total_space': 'str', 'total_space_bytes': 'int', 'used_space': 'str', 'used_space_bytes': 'int', 'utilization': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

total_space

Gets the total_space of this StorageUsageDTO. Amount of total space.

Returns:The total_space of this StorageUsageDTO.
Return type:str
total_space_bytes

Gets the total_space_bytes of this StorageUsageDTO. The number of bytes of total space.

Returns:The total_space_bytes of this StorageUsageDTO.
Return type:int
used_space

Gets the used_space of this StorageUsageDTO. Amount of used space.

Returns:The used_space of this StorageUsageDTO.
Return type:str
used_space_bytes

Gets the used_space_bytes of this StorageUsageDTO. The number of bytes of used space.

Returns:The used_space_bytes of this StorageUsageDTO.
Return type:int
utilization

Gets the utilization of this StorageUsageDTO. Utilization of this storage location.

Returns:The utilization of this StorageUsageDTO.
Return type:str

nipyapi.nifi.models.streaming_output 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.streaming_output.StreamingOutput[source]

Bases: object

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

StreamingOutput - a model defined in Swagger

attribute_map = {}
swagger_types = {}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.submit_replay_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.submit_replay_request_entity.SubmitReplayRequestEntity(event_id=None, cluster_node_id=None)[source]

Bases: object

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

SubmitReplayRequestEntity - a model defined in Swagger

attribute_map = {'cluster_node_id': 'clusterNodeId', 'event_id': 'eventId'}
cluster_node_id

Gets the cluster_node_id of this SubmitReplayRequestEntity. The identifier of the node where to submit the replay request.

Returns:The cluster_node_id of this SubmitReplayRequestEntity.
Return type:str
event_id

Gets the event_id of this SubmitReplayRequestEntity. The event identifier

Returns:The event_id of this SubmitReplayRequestEntity.
Return type:int
swagger_types = {'cluster_node_id': 'str', 'event_id': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.system_diagnostics_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.system_diagnostics_dto.SystemDiagnosticsDTO(aggregate_snapshot=None, node_snapshots=None)[source]

Bases: object

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

SystemDiagnosticsDTO - a model defined in Swagger

aggregate_snapshot

Gets the aggregate_snapshot of this SystemDiagnosticsDTO. A systems diagnostic 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 SystemDiagnosticsDTO.
Return type:SystemDiagnosticsSnapshotDTO
attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'node_snapshots': 'nodeSnapshots'}
node_snapshots

Gets the node_snapshots of this SystemDiagnosticsDTO. A systems diagnostics 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 SystemDiagnosticsDTO.
Return type:list[NodeSystemDiagnosticsSnapshotDTO]
swagger_types = {'aggregate_snapshot': 'SystemDiagnosticsSnapshotDTO', 'node_snapshots': 'list[NodeSystemDiagnosticsSnapshotDTO]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.system_diagnostics_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.system_diagnostics_entity.SystemDiagnosticsEntity(system_diagnostics=None)[source]

Bases: object

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

SystemDiagnosticsEntity - a model defined in Swagger

attribute_map = {'system_diagnostics': 'systemDiagnostics'}
swagger_types = {'system_diagnostics': 'SystemDiagnosticsDTO'}
system_diagnostics

Gets the system_diagnostics of this SystemDiagnosticsEntity.

Returns:The system_diagnostics of this SystemDiagnosticsEntity.
Return type:SystemDiagnosticsDTO
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.system_diagnostics_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.system_diagnostics_snapshot_dto.SystemDiagnosticsSnapshotDTO(total_non_heap=None, total_non_heap_bytes=None, used_non_heap=None, used_non_heap_bytes=None, free_non_heap=None, free_non_heap_bytes=None, max_non_heap=None, max_non_heap_bytes=None, non_heap_utilization=None, total_heap=None, total_heap_bytes=None, used_heap=None, used_heap_bytes=None, free_heap=None, free_heap_bytes=None, max_heap=None, max_heap_bytes=None, heap_utilization=None, available_processors=None, processor_load_average=None, total_threads=None, daemon_threads=None, uptime=None, flow_file_repository_storage_usage=None, content_repository_storage_usage=None, provenance_repository_storage_usage=None, garbage_collection=None, stats_last_refreshed=None, version_info=None)[source]

Bases: object

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

SystemDiagnosticsSnapshotDTO - a model defined in Swagger

attribute_map = {'available_processors': 'availableProcessors', 'content_repository_storage_usage': 'contentRepositoryStorageUsage', 'daemon_threads': 'daemonThreads', 'flow_file_repository_storage_usage': 'flowFileRepositoryStorageUsage', 'free_heap': 'freeHeap', 'free_heap_bytes': 'freeHeapBytes', 'free_non_heap': 'freeNonHeap', 'free_non_heap_bytes': 'freeNonHeapBytes', 'garbage_collection': 'garbageCollection', 'heap_utilization': 'heapUtilization', 'max_heap': 'maxHeap', 'max_heap_bytes': 'maxHeapBytes', 'max_non_heap': 'maxNonHeap', 'max_non_heap_bytes': 'maxNonHeapBytes', 'non_heap_utilization': 'nonHeapUtilization', 'processor_load_average': 'processorLoadAverage', 'provenance_repository_storage_usage': 'provenanceRepositoryStorageUsage', 'stats_last_refreshed': 'statsLastRefreshed', 'total_heap': 'totalHeap', 'total_heap_bytes': 'totalHeapBytes', 'total_non_heap': 'totalNonHeap', 'total_non_heap_bytes': 'totalNonHeapBytes', 'total_threads': 'totalThreads', 'uptime': 'uptime', 'used_heap': 'usedHeap', 'used_heap_bytes': 'usedHeapBytes', 'used_non_heap': 'usedNonHeap', 'used_non_heap_bytes': 'usedNonHeapBytes', 'version_info': 'versionInfo'}
available_processors

Gets the available_processors of this SystemDiagnosticsSnapshotDTO. Number of available processors if supported by the underlying system.

Returns:The available_processors of this SystemDiagnosticsSnapshotDTO.
Return type:int
content_repository_storage_usage

Gets the content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. The content repository storage usage.

Returns:The content_repository_storage_usage of this SystemDiagnosticsSnapshotDTO.
Return type:list[StorageUsageDTO]
daemon_threads

Gets the daemon_threads of this SystemDiagnosticsSnapshotDTO. Number of daemon threads.

Returns:The daemon_threads of this SystemDiagnosticsSnapshotDTO.
Return type:int
flow_file_repository_storage_usage

Gets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. The flowfile repository storage usage.

Returns:The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO.
Return type:StorageUsageDTO
free_heap

Gets the free_heap of this SystemDiagnosticsSnapshotDTO. Amount of free heap.

Returns:The free_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
free_heap_bytes

Gets the free_heap_bytes of this SystemDiagnosticsSnapshotDTO. The number of bytes that are allocated to the JVM heap but not currently being used

Returns:The free_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
free_non_heap

Gets the free_non_heap of this SystemDiagnosticsSnapshotDTO. Amount of free non heap.

Returns:The free_non_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
free_non_heap_bytes

Gets the free_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Total number of free non-heap bytes available to the JVM

Returns:The free_non_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
garbage_collection

Gets the garbage_collection of this SystemDiagnosticsSnapshotDTO. The garbage collection details.

Returns:The garbage_collection of this SystemDiagnosticsSnapshotDTO.
Return type:list[GarbageCollectionDTO]
heap_utilization

Gets the heap_utilization of this SystemDiagnosticsSnapshotDTO. Utilization of heap.

Returns:The heap_utilization of this SystemDiagnosticsSnapshotDTO.
Return type:str
max_heap

Gets the max_heap of this SystemDiagnosticsSnapshotDTO. Maximum size of heap.

Returns:The max_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
max_heap_bytes

Gets the max_heap_bytes of this SystemDiagnosticsSnapshotDTO. The maximum number of bytes that can be used by the JVM

Returns:The max_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
max_non_heap

Gets the max_non_heap of this SystemDiagnosticsSnapshotDTO. Maximum size of non heap.

Returns:The max_non_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
max_non_heap_bytes

Gets the max_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. The maximum number of bytes that the JVM can use for non-heap purposes

Returns:The max_non_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
non_heap_utilization

Gets the non_heap_utilization of this SystemDiagnosticsSnapshotDTO. Utilization of non heap.

Returns:The non_heap_utilization of this SystemDiagnosticsSnapshotDTO.
Return type:str
processor_load_average

Gets the processor_load_average of this SystemDiagnosticsSnapshotDTO. The processor load average if supported by the underlying system.

Returns:The processor_load_average of this SystemDiagnosticsSnapshotDTO.
Return type:float
provenance_repository_storage_usage

Gets the provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO. The provenance repository storage usage.

Returns:The provenance_repository_storage_usage of this SystemDiagnosticsSnapshotDTO.
Return type:list[StorageUsageDTO]
stats_last_refreshed

Gets the stats_last_refreshed of this SystemDiagnosticsSnapshotDTO. When the diagnostics were generated.

Returns:The stats_last_refreshed of this SystemDiagnosticsSnapshotDTO.
Return type:str
swagger_types = {'available_processors': 'int', 'content_repository_storage_usage': 'list[StorageUsageDTO]', 'daemon_threads': 'int', 'flow_file_repository_storage_usage': 'StorageUsageDTO', 'free_heap': 'str', 'free_heap_bytes': 'int', 'free_non_heap': 'str', 'free_non_heap_bytes': 'int', 'garbage_collection': 'list[GarbageCollectionDTO]', 'heap_utilization': 'str', 'max_heap': 'str', 'max_heap_bytes': 'int', 'max_non_heap': 'str', 'max_non_heap_bytes': 'int', 'non_heap_utilization': 'str', 'processor_load_average': 'float', 'provenance_repository_storage_usage': 'list[StorageUsageDTO]', 'stats_last_refreshed': 'str', 'total_heap': 'str', 'total_heap_bytes': 'int', 'total_non_heap': 'str', 'total_non_heap_bytes': 'int', 'total_threads': 'int', 'uptime': 'str', 'used_heap': 'str', 'used_heap_bytes': 'int', 'used_non_heap': 'str', 'used_non_heap_bytes': 'int', 'version_info': 'VersionInfoDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

total_heap

Gets the total_heap of this SystemDiagnosticsSnapshotDTO. Total size of heap.

Returns:The total_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
total_heap_bytes

Gets the total_heap_bytes of this SystemDiagnosticsSnapshotDTO. The total number of bytes that are available for the JVM heap to use

Returns:The total_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
total_non_heap

Gets the total_non_heap of this SystemDiagnosticsSnapshotDTO. Total size of non heap.

Returns:The total_non_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
total_non_heap_bytes

Gets the total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Total number of bytes allocated to the JVM not used for heap

Returns:The total_non_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
total_threads

Gets the total_threads of this SystemDiagnosticsSnapshotDTO. Total number of threads.

Returns:The total_threads of this SystemDiagnosticsSnapshotDTO.
Return type:int
uptime

Gets the uptime of this SystemDiagnosticsSnapshotDTO. The uptime of the Java virtual machine

Returns:The uptime of this SystemDiagnosticsSnapshotDTO.
Return type:str
used_heap

Gets the used_heap of this SystemDiagnosticsSnapshotDTO. Amount of used heap.

Returns:The used_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
used_heap_bytes

Gets the used_heap_bytes of this SystemDiagnosticsSnapshotDTO. The number of bytes of JVM heap that are currently being used

Returns:The used_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
used_non_heap

Gets the used_non_heap of this SystemDiagnosticsSnapshotDTO. Amount of use non heap.

Returns:The used_non_heap of this SystemDiagnosticsSnapshotDTO.
Return type:str
used_non_heap_bytes

Gets the used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO. Total number of bytes used by the JVM not in the heap space

Returns:The used_non_heap_bytes of this SystemDiagnosticsSnapshotDTO.
Return type:int
version_info

Gets the version_info of this SystemDiagnosticsSnapshotDTO. The nifi, os, java, and build version information

Returns:The version_info of this SystemDiagnosticsSnapshotDTO.
Return type:VersionInfoDTO

nipyapi.nifi.models.template_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.template_dto.TemplateDTO(uri=None, id=None, group_id=None, name=None, description=None, timestamp=None, encoding_version=None, snippet=None)[source]

Bases: object

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

TemplateDTO - a model defined in Swagger

attribute_map = {'description': 'description', 'encoding_version': 'encodingVersion', 'group_id': 'groupId', 'id': 'id', 'name': 'name', 'snippet': 'snippet', 'timestamp': 'timestamp', 'uri': 'uri'}
description

Gets the description of this TemplateDTO. The description of the template.

Returns:The description of this TemplateDTO.
Return type:str
encoding_version

Gets the encoding_version of this TemplateDTO. The encoding version of this template.

Returns:The encoding_version of this TemplateDTO.
Return type:str
group_id

Gets the group_id of this TemplateDTO. The id of the Process Group that the template belongs to.

Returns:The group_id of this TemplateDTO.
Return type:str
id

Gets the id of this TemplateDTO. The id of the template.

Returns:The id of this TemplateDTO.
Return type:str
name

Gets the name of this TemplateDTO. The name of the template.

Returns:The name of this TemplateDTO.
Return type:str
snippet

Gets the snippet of this TemplateDTO. The contents of the template.

Returns:The snippet of this TemplateDTO.
Return type:FlowSnippetDTO
swagger_types = {'description': 'str', 'encoding_version': 'str', 'group_id': 'str', 'id': 'str', 'name': 'str', 'snippet': 'FlowSnippetDTO', 'timestamp': 'str', 'uri': 'str'}
timestamp

Gets the timestamp of this TemplateDTO. The timestamp when this template was created.

Returns:The timestamp of this TemplateDTO.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

Gets the uri of this TemplateDTO. The URI for the template.

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

nipyapi.nifi.models.template_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.template_entity.TemplateEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, template=None)[source]

Bases: object

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

TemplateEntity - a model defined in Swagger

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

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

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

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

Returns:The disconnected_node_acknowledged of this TemplateEntity.
Return type:bool
id

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

Returns:The id of this TemplateEntity.
Return type:str
permissions

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

Returns:The permissions of this TemplateEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this TemplateEntity.
Return type:PositionDTO
revision

Gets the revision of this TemplateEntity. 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 TemplateEntity.
Return type:RevisionDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'template': 'TemplateDTO', 'uri': 'str'}
template

Gets the template of this TemplateEntity.

Returns:The template of this TemplateEntity.
Return type:TemplateDTO
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.templates_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.templates_entity.TemplatesEntity(templates=None, generated=None)[source]

Bases: object

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

TemplatesEntity - a model defined in Swagger

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

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

Returns:The generated of this TemplatesEntity.
Return type:str
swagger_types = {'generated': 'str', 'templates': 'list[TemplateEntity]'}
templates

Gets the templates of this TemplatesEntity.

Returns:The templates of this TemplatesEntity.
Return type:list[TemplateEntity]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.tenant_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.tenant_dto.TenantDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None)[source]

Bases: object

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

TenantDTO - a model defined in Swagger

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

Gets the configurable of this TenantDTO. Whether this tenant is configurable.

Returns:The configurable of this TenantDTO.
Return type:bool
id

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

Returns:The id of this TenantDTO.
Return type:str
identity

Gets the identity of this TenantDTO. The identity of the tenant.

Returns:The identity of this TenantDTO.
Return type:str
parent_group_id

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

Returns:The parent_group_id of this TenantDTO.
Return type:str
position

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

Returns:The position of this TenantDTO.
Return type:PositionDTO
swagger_types = {'configurable': 'bool', 'id': 'str', 'identity': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

versioned_component_id

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

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

nipyapi.nifi.models.tenant_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.tenant_entity.TenantEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)[source]

Bases: object

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

TenantEntity - 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 TenantEntity. The bulletins for this component.

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

Gets the component of this TenantEntity.

Returns:The component of this TenantEntity.
Return type:TenantDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this TenantEntity.
Return type:bool
id

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

Returns:The id of this TenantEntity.
Return type:str
permissions

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

Returns:The permissions of this TenantEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this TenantEntity.
Return type:PositionDTO
revision

Gets the revision of this TenantEntity. 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 TenantEntity.
Return type:RevisionDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'TenantDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.tenants_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.tenants_entity.TenantsEntity(users=None, user_groups=None)[source]

Bases: object

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

TenantsEntity - a model defined in Swagger

attribute_map = {'user_groups': 'userGroups', 'users': 'users'}
swagger_types = {'user_groups': 'list[TenantEntity]', 'users': 'list[TenantEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

user_groups

Gets the user_groups of this TenantsEntity.

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

Gets the users of this TenantsEntity.

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

nipyapi.nifi.models.the_position_of_a_component_on_the_graph module

nipyapi.nifi.models.transaction_result_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.transaction_result_entity.TransactionResultEntity(flow_file_sent=None, response_code=None, message=None)[source]

Bases: object

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

TransactionResultEntity - a model defined in Swagger

attribute_map = {'flow_file_sent': 'flowFileSent', 'message': 'message', 'response_code': 'responseCode'}
flow_file_sent

Gets the flow_file_sent of this TransactionResultEntity.

Returns:The flow_file_sent of this TransactionResultEntity.
Return type:int
message

Gets the message of this TransactionResultEntity.

Returns:The message of this TransactionResultEntity.
Return type:str
response_code

Gets the response_code of this TransactionResultEntity.

Returns:The response_code of this TransactionResultEntity.
Return type:int
swagger_types = {'flow_file_sent': 'int', 'message': 'str', 'response_code': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.update_controller_service_reference_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.update_controller_service_reference_request_entity.UpdateControllerServiceReferenceRequestEntity(id=None, state=None, referencing_component_revisions=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

UpdateControllerServiceReferenceRequestEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'referencing_component_revisions': 'referencingComponentRevisions', 'state': 'state'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this UpdateControllerServiceReferenceRequestEntity.
Return type:bool
id

Gets the id of this UpdateControllerServiceReferenceRequestEntity. The identifier of the Controller Service.

Returns:The id of this UpdateControllerServiceReferenceRequestEntity.
Return type:str
referencing_component_revisions

Gets the referencing_component_revisions of this UpdateControllerServiceReferenceRequestEntity. The revisions for all referencing components.

Returns:The referencing_component_revisions of this UpdateControllerServiceReferenceRequestEntity.
Return type:dict(str, RevisionDTO)
state

Gets the state of this UpdateControllerServiceReferenceRequestEntity. The new state of the references for the controller service.

Returns:The state of this UpdateControllerServiceReferenceRequestEntity.
Return type:str
swagger_types = {'disconnected_node_acknowledged': 'bool', 'id': 'str', 'referencing_component_revisions': 'dict(str, RevisionDTO)', 'state': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.uri_builder module

nipyapi.nifi.models.user_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_dto.UserDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None, user_groups=None, access_policies=None)[source]

Bases: object

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

UserDTO - a model defined in Swagger

access_policies

Gets the access_policies of this UserDTO. The access policies this user belongs to.

Returns:The access_policies of this UserDTO.
Return type:list[AccessPolicySummaryEntity]
attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'id': 'id', 'identity': 'identity', 'parent_group_id': 'parentGroupId', 'position': 'position', 'user_groups': 'userGroups', 'versioned_component_id': 'versionedComponentId'}
configurable

Gets the configurable of this UserDTO. Whether this tenant is configurable.

Returns:The configurable of this UserDTO.
Return type:bool
id

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

Returns:The id of this UserDTO.
Return type:str
identity

Gets the identity of this UserDTO. The identity of the tenant.

Returns:The identity of this UserDTO.
Return type:str
parent_group_id

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

Returns:The parent_group_id of this UserDTO.
Return type:str
position

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

Returns:The position of this UserDTO.
Return type:PositionDTO
swagger_types = {'access_policies': 'list[AccessPolicySummaryEntity]', 'configurable': 'bool', 'id': 'str', 'identity': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'user_groups': 'list[TenantEntity]', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

user_groups

Gets the user_groups of this UserDTO. The groups to which the user belongs. This field is read only and it provided for convenience.

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

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

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

nipyapi.nifi.models.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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_entity.UserEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)[source]

Bases: object

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

UserEntity - 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 UserEntity. The bulletins for this component.

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

Gets the component of this UserEntity.

Returns:The component of this UserEntity.
Return type:UserDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this UserEntity.
Return type:bool
id

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

Returns:The id of this UserEntity.
Return type:str
permissions

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

Returns:The permissions of this UserEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this UserEntity.
Return type:PositionDTO
revision

Gets the revision of this UserEntity. 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 UserEntity.
Return type:RevisionDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'UserDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.user_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_group_dto.UserGroupDTO(id=None, versioned_component_id=None, parent_group_id=None, position=None, identity=None, configurable=None, users=None, access_policies=None)[source]

Bases: object

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

UserGroupDTO - a model defined in Swagger

access_policies

Gets the access_policies of this UserGroupDTO. The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.

Returns:The access_policies of this UserGroupDTO.
Return type:list[AccessPolicyEntity]
attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'id': 'id', 'identity': 'identity', 'parent_group_id': 'parentGroupId', 'position': 'position', 'users': 'users', 'versioned_component_id': 'versionedComponentId'}
configurable

Gets the configurable of this UserGroupDTO. Whether this tenant is configurable.

Returns:The configurable of this UserGroupDTO.
Return type:bool
id

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

Returns:The id of this UserGroupDTO.
Return type:str
identity

Gets the identity of this UserGroupDTO. The identity of the tenant.

Returns:The identity of this UserGroupDTO.
Return type:str
parent_group_id

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

Returns:The parent_group_id of this UserGroupDTO.
Return type:str
position

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

Returns:The position of this UserGroupDTO.
Return type:PositionDTO
swagger_types = {'access_policies': 'list[AccessPolicyEntity]', 'configurable': 'bool', 'id': 'str', 'identity': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'users': 'list[TenantEntity]', 'versioned_component_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

users

Gets the users of this UserGroupDTO. The users that belong to the user group.

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

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

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

nipyapi.nifi.models.user_group_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_group_entity.UserGroupEntity(revision=None, id=None, uri=None, position=None, permissions=None, bulletins=None, disconnected_node_acknowledged=None, component=None)[source]

Bases: object

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

UserGroupEntity - 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 UserGroupEntity. The bulletins for this component.

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

Gets the component of this UserGroupEntity.

Returns:The component of this UserGroupEntity.
Return type:UserGroupDTO
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this UserGroupEntity.
Return type:bool
id

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

Returns:The id of this UserGroupEntity.
Return type:str
permissions

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

Returns:The permissions of this UserGroupEntity.
Return type:PermissionsDTO
position

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

Returns:The position of this UserGroupEntity.
Return type:PositionDTO
revision

Gets the revision of this UserGroupEntity. 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 UserGroupEntity.
Return type:RevisionDTO
swagger_types = {'bulletins': 'list[BulletinEntity]', 'component': 'UserGroupDTO', 'disconnected_node_acknowledged': 'bool', 'id': 'str', 'permissions': 'PermissionsDTO', 'position': 'PositionDTO', 'revision': 'RevisionDTO', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

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

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

nipyapi.nifi.models.user_groups_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.user_groups_entity.UserGroupsEntity(user_groups=None)[source]

Bases: object

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

UserGroupsEntity - a model defined in Swagger

attribute_map = {'user_groups': 'userGroups'}
swagger_types = {'user_groups': 'list[UserGroupEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

user_groups

Gets the user_groups of this UserGroupsEntity.

Returns:The user_groups of this UserGroupsEntity.
Return type:list[UserGroupEntity]

nipyapi.nifi.models.users_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.users_entity.UsersEntity(generated=None, users=None)[source]

Bases: object

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

UsersEntity - a model defined in Swagger

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

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

Returns:The generated of this UsersEntity.
Return type:str
swagger_types = {'generated': 'str', 'users': 'list[UserEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

users

Gets the users of this UsersEntity.

Returns:The users of this UsersEntity.
Return type:list[UserEntity]

nipyapi.nifi.models.variable_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_dto.VariableDTO(name=None, value=None, process_group_id=None, affected_components=None)[source]

Bases: object

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

VariableDTO - a model defined in Swagger

affected_components

Gets the affected_components of this VariableDTO. A set of all components that will be affected if the value of this variable is changed

Returns:The affected_components of this VariableDTO.
Return type:list[AffectedComponentEntity]
attribute_map = {'affected_components': 'affectedComponents', 'name': 'name', 'process_group_id': 'processGroupId', 'value': 'value'}
name

Gets the name of this VariableDTO. The name of the variable

Returns:The name of this VariableDTO.
Return type:str
process_group_id

Gets the process_group_id of this VariableDTO. The ID of the Process Group where this Variable is defined

Returns:The process_group_id of this VariableDTO.
Return type:str
swagger_types = {'affected_components': 'list[AffectedComponentEntity]', 'name': 'str', 'process_group_id': 'str', 'value': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

value

Gets the value of this VariableDTO. The value of the variable

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

nipyapi.nifi.models.variable_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_entity.VariableEntity(variable=None, can_write=None)[source]

Bases: object

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

VariableEntity - a model defined in Swagger

attribute_map = {'can_write': 'canWrite', 'variable': 'variable'}
can_write

Gets the can_write of this VariableEntity. Indicates whether the user can write a given resource.

Returns:The can_write of this VariableEntity.
Return type:bool
swagger_types = {'can_write': 'bool', 'variable': 'VariableDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

variable

Gets the variable of this VariableEntity. The variable information

Returns:The variable of this VariableEntity.
Return type:VariableDTO

nipyapi.nifi.models.variable_registry_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_dto.VariableRegistryDTO(variables=None, process_group_id=None)[source]

Bases: object

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

VariableRegistryDTO - a model defined in Swagger

attribute_map = {'process_group_id': 'processGroupId', 'variables': 'variables'}
process_group_id

Gets the process_group_id of this VariableRegistryDTO. The UUID of the Process Group that this Variable Registry belongs to

Returns:The process_group_id of this VariableRegistryDTO.
Return type:str
swagger_types = {'process_group_id': 'str', 'variables': 'list[VariableEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

variables

Gets the variables of this VariableRegistryDTO. The variables that are available in this Variable Registry

Returns:The variables of this VariableRegistryDTO.
Return type:list[VariableEntity]

nipyapi.nifi.models.variable_registry_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_entity.VariableRegistryEntity(process_group_revision=None, variable_registry=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

VariableRegistryEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'variable_registry': 'variableRegistry'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this VariableRegistryEntity.
Return type:bool
process_group_revision

Gets the process_group_revision of this VariableRegistryEntity. The revision of the Process Group that the Variable Registry belongs to

Returns:The process_group_revision of this VariableRegistryEntity.
Return type:RevisionDTO
swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'variable_registry': 'VariableRegistryDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

variable_registry

Gets the variable_registry of this VariableRegistryEntity. The Variable Registry.

Returns:The variable_registry of this VariableRegistryEntity.
Return type:VariableRegistryDTO

nipyapi.nifi.models.variable_registry_update_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_update_request_dto.VariableRegistryUpdateRequestDTO(request_id=None, uri=None, submission_time=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, update_steps=None, process_group_id=None, affected_components=None)[source]

Bases: object

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

VariableRegistryUpdateRequestDTO - a model defined in Swagger

affected_components

Gets the affected_components of this VariableRegistryUpdateRequestDTO. A set of all components that will be affected if the value of this variable is changed

Returns:The affected_components of this VariableRegistryUpdateRequestDTO.
Return type:list[AffectedComponentEntity]
attribute_map = {'affected_components': 'affectedComponents', 'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'percent_completed': 'percentCompleted', 'process_group_id': 'processGroupId', 'request_id': 'requestId', 'state': 'state', 'submission_time': 'submissionTime', 'update_steps': 'updateSteps', 'uri': 'uri'}
complete

Gets the complete of this VariableRegistryUpdateRequestDTO. Whether or not the request is completed

Returns:The complete of this VariableRegistryUpdateRequestDTO.
Return type:bool
failure_reason

Gets the failure_reason of this VariableRegistryUpdateRequestDTO. The reason for the request failing, or null if the request has not failed

Returns:The failure_reason of this VariableRegistryUpdateRequestDTO.
Return type:str
last_updated

Gets the last_updated of this VariableRegistryUpdateRequestDTO. The timestamp of when the request was last updated

Returns:The last_updated of this VariableRegistryUpdateRequestDTO.
Return type:datetime
percent_completed

Gets the percent_completed of this VariableRegistryUpdateRequestDTO. A value between 0 and 100 (inclusive) indicating how close the request is to completion

Returns:The percent_completed of this VariableRegistryUpdateRequestDTO.
Return type:int
process_group_id

Gets the process_group_id of this VariableRegistryUpdateRequestDTO. The unique ID of the Process Group that the variable registry belongs to

Returns:The process_group_id of this VariableRegistryUpdateRequestDTO.
Return type:str
request_id

Gets the request_id of this VariableRegistryUpdateRequestDTO. The ID of the request

Returns:The request_id of this VariableRegistryUpdateRequestDTO.
Return type:str
state

Gets the state of this VariableRegistryUpdateRequestDTO. A description of the current state of the request

Returns:The state of this VariableRegistryUpdateRequestDTO.
Return type:str
submission_time

Gets the submission_time of this VariableRegistryUpdateRequestDTO. The timestamp of when the request was submitted

Returns:The submission_time of this VariableRegistryUpdateRequestDTO.
Return type:datetime
swagger_types = {'affected_components': 'list[AffectedComponentEntity]', 'complete': 'bool', 'failure_reason': 'str', 'last_updated': 'datetime', 'percent_completed': 'int', 'process_group_id': 'str', 'request_id': 'str', 'state': 'str', 'submission_time': 'datetime', 'update_steps': 'list[VariableRegistryUpdateStepDTO]', 'uri': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

update_steps

Gets the update_steps of this VariableRegistryUpdateRequestDTO. The steps that are required in order to complete the request, along with the status of each

Returns:The update_steps of this VariableRegistryUpdateRequestDTO.
Return type:list[VariableRegistryUpdateStepDTO]
uri

Gets the uri of this VariableRegistryUpdateRequestDTO. The URI for the request

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

nipyapi.nifi.models.variable_registry_update_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_update_request_entity.VariableRegistryUpdateRequestEntity(request=None, process_group_revision=None)[source]

Bases: object

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

VariableRegistryUpdateRequestEntity - a model defined in Swagger

attribute_map = {'process_group_revision': 'processGroupRevision', 'request': 'request'}
process_group_revision

Gets the process_group_revision of this VariableRegistryUpdateRequestEntity. The revision for the Process Group that owns this variable registry.

Returns:The process_group_revision of this VariableRegistryUpdateRequestEntity.
Return type:RevisionDTO
request

Gets the request of this VariableRegistryUpdateRequestEntity. The Variable Registry Update Request

Returns:The request of this VariableRegistryUpdateRequestEntity.
Return type:VariableRegistryUpdateRequestDTO
swagger_types = {'process_group_revision': 'RevisionDTO', 'request': 'VariableRegistryUpdateRequestDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.variable_registry_update_step_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.variable_registry_update_step_dto.VariableRegistryUpdateStepDTO(description=None, complete=None, failure_reason=None)[source]

Bases: object

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

VariableRegistryUpdateStepDTO - a model defined in Swagger

attribute_map = {'complete': 'complete', 'description': 'description', 'failure_reason': 'failureReason'}
complete

Gets the complete of this VariableRegistryUpdateStepDTO. Whether or not this step has completed

Returns:The complete of this VariableRegistryUpdateStepDTO.
Return type:bool
description

Gets the description of this VariableRegistryUpdateStepDTO. Explanation of what happens in this step

Returns:The description of this VariableRegistryUpdateStepDTO.
Return type:str
failure_reason

Gets the failure_reason of this VariableRegistryUpdateStepDTO. An explanation of why this step failed, or null if this step did not fail

Returns:The failure_reason of this VariableRegistryUpdateStepDTO.
Return type:str
swagger_types = {'complete': 'bool', 'description': 'str', 'failure_reason': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.version_control_component_mapping_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_control_component_mapping_entity.VersionControlComponentMappingEntity(version_control_component_mapping=None, process_group_revision=None, disconnected_node_acknowledged=None, version_control_information=None)[source]

Bases: object

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

VersionControlComponentMappingEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'version_control_component_mapping': 'versionControlComponentMapping', 'version_control_information': 'versionControlInformation'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this VersionControlComponentMappingEntity.
Return type:bool
process_group_revision

Gets the process_group_revision of this VersionControlComponentMappingEntity. The revision of the Process Group

Returns:The process_group_revision of this VersionControlComponentMappingEntity.
Return type:RevisionDTO
swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'version_control_component_mapping': 'dict(str, str)', 'version_control_information': 'VersionControlInformationDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

version_control_component_mapping

Gets the version_control_component_mapping of this VersionControlComponentMappingEntity. The mapping of Versioned Component Identifiers to instance ID’s

Returns:The version_control_component_mapping of this VersionControlComponentMappingEntity.
Return type:dict(str, str)
version_control_information

Gets the version_control_information of this VersionControlComponentMappingEntity. The Version Control information

Returns:The version_control_information of this VersionControlComponentMappingEntity.
Return type:VersionControlInformationDTO

nipyapi.nifi.models.version_control_information_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_control_information_dto.VersionControlInformationDTO(group_id=None, registry_id=None, registry_name=None, bucket_id=None, bucket_name=None, flow_id=None, flow_name=None, flow_description=None, version=None, state=None, state_explanation=None)[source]

Bases: object

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

VersionControlInformationDTO - a model defined in Swagger

attribute_map = {'bucket_id': 'bucketId', 'bucket_name': 'bucketName', 'flow_description': 'flowDescription', 'flow_id': 'flowId', 'flow_name': 'flowName', 'group_id': 'groupId', 'registry_id': 'registryId', 'registry_name': 'registryName', 'state': 'state', 'state_explanation': 'stateExplanation', 'version': 'version'}
bucket_id

Gets the bucket_id of this VersionControlInformationDTO. The ID of the bucket that the flow is stored in

Returns:The bucket_id of this VersionControlInformationDTO.
Return type:str
bucket_name

Gets the bucket_name of this VersionControlInformationDTO. The name of the bucket that the flow is stored in

Returns:The bucket_name of this VersionControlInformationDTO.
Return type:str
flow_description

Gets the flow_description of this VersionControlInformationDTO. The description of the flow

Returns:The flow_description of this VersionControlInformationDTO.
Return type:str
flow_id

Gets the flow_id of this VersionControlInformationDTO. The ID of the flow

Returns:The flow_id of this VersionControlInformationDTO.
Return type:str
flow_name

Gets the flow_name of this VersionControlInformationDTO. The name of the flow

Returns:The flow_name of this VersionControlInformationDTO.
Return type:str
group_id

Gets the group_id of this VersionControlInformationDTO. The ID of the Process Group that is under version control

Returns:The group_id of this VersionControlInformationDTO.
Return type:str
registry_id

Gets the registry_id of this VersionControlInformationDTO. The ID of the registry that the flow is stored in

Returns:The registry_id of this VersionControlInformationDTO.
Return type:str
registry_name

Gets the registry_name of this VersionControlInformationDTO. The name of the registry that the flow is stored in

Returns:The registry_name of this VersionControlInformationDTO.
Return type:str
state

Gets the state of this VersionControlInformationDTO. The current state of the Process Group, as it relates to the Versioned Flow

Returns:The state of this VersionControlInformationDTO.
Return type:str
state_explanation

Gets the state_explanation of this VersionControlInformationDTO. Explanation of why the group is in the specified state

Returns:The state_explanation of this VersionControlInformationDTO.
Return type:str
swagger_types = {'bucket_id': 'str', 'bucket_name': 'str', 'flow_description': 'str', 'flow_id': 'str', 'flow_name': 'str', 'group_id': 'str', 'registry_id': 'str', 'registry_name': 'str', 'state': 'str', 'state_explanation': 'str', 'version': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

version

Gets the version of this VersionControlInformationDTO. The version of the flow

Returns:The version of this VersionControlInformationDTO.
Return type:int

nipyapi.nifi.models.version_control_information_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_control_information_entity.VersionControlInformationEntity(version_control_information=None, process_group_revision=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

VersionControlInformationEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'version_control_information': 'versionControlInformation'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this VersionControlInformationEntity.
Return type:bool
process_group_revision

Gets the process_group_revision of this VersionControlInformationEntity. The Revision for the Process Group

Returns:The process_group_revision of this VersionControlInformationEntity.
Return type:RevisionDTO
swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'version_control_information': 'VersionControlInformationDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

version_control_information

Gets the version_control_information of this VersionControlInformationEntity. The Version Control information

Returns:The version_control_information of this VersionControlInformationEntity.
Return type:VersionControlInformationDTO

nipyapi.nifi.models.version_info_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.version_info_dto.VersionInfoDTO(ni_fi_version=None, java_vendor=None, java_version=None, os_name=None, os_version=None, os_architecture=None, build_tag=None, build_revision=None, build_branch=None, build_timestamp=None)[source]

Bases: object

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

VersionInfoDTO - a model defined in Swagger

attribute_map = {'build_branch': 'buildBranch', 'build_revision': 'buildRevision', 'build_tag': 'buildTag', 'build_timestamp': 'buildTimestamp', 'java_vendor': 'javaVendor', 'java_version': 'javaVersion', 'ni_fi_version': 'niFiVersion', 'os_architecture': 'osArchitecture', 'os_name': 'osName', 'os_version': 'osVersion'}
build_branch

Gets the build_branch of this VersionInfoDTO. Build branch

Returns:The build_branch of this VersionInfoDTO.
Return type:str
build_revision

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

Returns:The build_revision of this VersionInfoDTO.
Return type:str
build_tag

Gets the build_tag of this VersionInfoDTO. Build tag

Returns:The build_tag of this VersionInfoDTO.
Return type:str
build_timestamp

Gets the build_timestamp of this VersionInfoDTO. Build timestamp

Returns:The build_timestamp of this VersionInfoDTO.
Return type:datetime
java_vendor

Gets the java_vendor of this VersionInfoDTO. Java JVM vendor

Returns:The java_vendor of this VersionInfoDTO.
Return type:str
java_version

Gets the java_version of this VersionInfoDTO. Java version

Returns:The java_version of this VersionInfoDTO.
Return type:str
ni_fi_version

Gets the ni_fi_version of this VersionInfoDTO. The version of this NiFi.

Returns:The ni_fi_version of this VersionInfoDTO.
Return type:str
os_architecture

Gets the os_architecture of this VersionInfoDTO. Host operating system architecture

Returns:The os_architecture of this VersionInfoDTO.
Return type:str
os_name

Gets the os_name of this VersionInfoDTO. Host operating system name

Returns:The os_name of this VersionInfoDTO.
Return type:str
os_version

Gets the os_version of this VersionInfoDTO. Host operating system version

Returns:The os_version of this VersionInfoDTO.
Return type:str
swagger_types = {'build_branch': 'str', 'build_revision': 'str', 'build_tag': 'str', 'build_timestamp': 'datetime', 'java_vendor': 'str', 'java_version': 'str', 'ni_fi_version': 'str', 'os_architecture': 'str', 'os_name': 'str', 'os_version': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.versioned_connection 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_connection.VersionedConnection(identifier=None, name=None, comments=None, position=None, source=None, destination=None, label_index=None, z_index=None, selected_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, partitioning_attribute=None, load_balance_compression=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedConnection - a model defined in Swagger

attribute_map = {'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'comments': 'comments', 'component_type': 'componentType', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'label_index': 'labelIndex', 'load_balance_compression': 'loadBalanceCompression', 'load_balance_strategy': 'loadBalanceStrategy', 'name': 'name', 'partitioning_attribute': 'partitioningAttribute', 'position': 'position', 'prioritizers': 'prioritizers', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'z_index': 'zIndex'}
back_pressure_data_size_threshold

Gets the back_pressure_data_size_threshold of this VersionedConnection. 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 VersionedConnection.
Return type:str
back_pressure_object_threshold

Gets the back_pressure_object_threshold of this VersionedConnection. 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 VersionedConnection.
Return type:int
bends

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

Returns:The bends of this VersionedConnection.
Return type:list[Position]
comments

Gets the comments of this VersionedConnection. The user-supplied comments for the component

Returns:The comments of this VersionedConnection.
Return type:str
component_type

Gets the component_type of this VersionedConnection.

Returns:The component_type of this VersionedConnection.
Return type:str
destination

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

Returns:The destination of this VersionedConnection.
Return type:ConnectableComponent
flow_file_expiration

Gets the flow_file_expiration of this VersionedConnection. 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 VersionedConnection.
Return type:str
group_identifier

Gets the group_identifier of this VersionedConnection. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedConnection.
Return type:str
identifier

Gets the identifier of this VersionedConnection. The component’s unique identifier

Returns:The identifier of this VersionedConnection.
Return type:str
label_index

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

Returns:The label_index of this VersionedConnection.
Return type:int
load_balance_compression

Gets the load_balance_compression of this VersionedConnection. Whether or not compression should be used when transferring FlowFiles between nodes

Returns:The load_balance_compression of this VersionedConnection.
Return type:str
load_balance_strategy

Gets the load_balance_strategy of this VersionedConnection. The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.

Returns:The load_balance_strategy of this VersionedConnection.
Return type:str
name

Gets the name of this VersionedConnection. The component’s name

Returns:The name of this VersionedConnection.
Return type:str
partitioning_attribute

Gets the partitioning_attribute of this VersionedConnection. The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.

Returns:The partitioning_attribute of this VersionedConnection.
Return type:str
position

Gets the position of this VersionedConnection. The component’s position on the graph

Returns:The position of this VersionedConnection.
Return type:Position
prioritizers

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

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

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

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

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

Returns:The source of this VersionedConnection.
Return type:ConnectableComponent
swagger_types = {'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[Position]', 'comments': 'str', 'component_type': 'str', 'destination': 'ConnectableComponent', 'flow_file_expiration': 'str', 'group_identifier': 'str', 'identifier': 'str', 'label_index': 'int', 'load_balance_compression': 'str', 'load_balance_strategy': 'str', 'name': 'str', 'partitioning_attribute': 'str', 'position': 'Position', 'prioritizers': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableComponent', 'z_index': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

z_index

Gets the z_index of this VersionedConnection. The z index of the connection.

Returns:The z_index of this VersionedConnection.
Return type:int

nipyapi.nifi.models.versioned_controller_service 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_controller_service.VersionedControllerService(identifier=None, name=None, comments=None, position=None, type=None, bundle=None, controller_service_apis=None, properties=None, property_descriptors=None, annotation_data=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedControllerService - a model defined in Swagger

annotation_data

Gets the annotation_data of this VersionedControllerService. The annotation for the controller service. This is how the custom UI relays configuration to the controller service.

Returns:The annotation_data of this VersionedControllerService.
Return type:str
attribute_map = {'annotation_data': 'annotationData', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'controller_service_apis': 'controllerServiceApis', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'name': 'name', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'type': 'type'}
bundle

Gets the bundle of this VersionedControllerService. The details of the artifact that bundled this processor type.

Returns:The bundle of this VersionedControllerService.
Return type:Bundle
comments

Gets the comments of this VersionedControllerService. The user-supplied comments for the component

Returns:The comments of this VersionedControllerService.
Return type:str
component_type

Gets the component_type of this VersionedControllerService.

Returns:The component_type of this VersionedControllerService.
Return type:str
controller_service_apis

Gets the controller_service_apis of this VersionedControllerService. Lists the APIs this Controller Service implements.

Returns:The controller_service_apis of this VersionedControllerService.
Return type:list[ControllerServiceAPI]
group_identifier

Gets the group_identifier of this VersionedControllerService. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedControllerService.
Return type:str
identifier

Gets the identifier of this VersionedControllerService. The component’s unique identifier

Returns:The identifier of this VersionedControllerService.
Return type:str
name

Gets the name of this VersionedControllerService. The component’s name

Returns:The name of this VersionedControllerService.
Return type:str
position

Gets the position of this VersionedControllerService. The component’s position on the graph

Returns:The position of this VersionedControllerService.
Return type:Position
properties

Gets the properties of this VersionedControllerService. The properties of the controller service.

Returns:The properties of this VersionedControllerService.
Return type:dict(str, str)
property_descriptors

Gets the property_descriptors of this VersionedControllerService. The property descriptors for the processor.

Returns:The property_descriptors of this VersionedControllerService.
Return type:dict(str, VersionedPropertyDescriptor)
swagger_types = {'annotation_data': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'controller_service_apis': 'list[ControllerServiceAPI]', 'group_identifier': 'str', 'identifier': 'str', 'name': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'type': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this VersionedControllerService. The type of the controller service.

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

nipyapi.nifi.models.versioned_flow 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow.VersionedFlow(link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, version_count=None)[source]

Bases: object

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

VersionedFlow - a model defined in Swagger

attribute_map = {'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'modified_timestamp': 'modifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'type': 'type', 'version_count': 'versionCount'}
bucket_identifier

Gets the bucket_identifier of this VersionedFlow. The identifier of the bucket this items belongs to. This cannot be changed after the item is created.

Returns:The bucket_identifier of this VersionedFlow.
Return type:str
bucket_name

Gets the bucket_name of this VersionedFlow. The name of the bucket this items belongs to.

Returns:The bucket_name of this VersionedFlow.
Return type:str
created_timestamp

Gets the created_timestamp of this VersionedFlow. The timestamp of when the item was created, as milliseconds since epoch.

Returns:The created_timestamp of this VersionedFlow.
Return type:int
description

Gets the description of this VersionedFlow. A description of the item.

Returns:The description of this VersionedFlow.
Return type:str
identifier

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

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

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

Returns:The link of this VersionedFlow.
Return type:JaxbLink
modified_timestamp

Gets the modified_timestamp of this VersionedFlow. The timestamp of when the item was last modified, as milliseconds since epoch.

Returns:The modified_timestamp of this VersionedFlow.
Return type:int
name

Gets the name of this VersionedFlow. The name of the item.

Returns:The name of this VersionedFlow.
Return type:str
permissions

Gets the permissions of this VersionedFlow. The access that the current user has to the bucket containing this item.

Returns:The permissions of this VersionedFlow.
Return type:Permissions
swagger_types = {'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'modified_timestamp': 'int', 'name': 'str', 'permissions': 'Permissions', 'type': 'str', 'version_count': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this VersionedFlow. The type of item.

Returns:The type of this VersionedFlow.
Return type:str
version_count

Gets the version_count of this VersionedFlow. The number of versions of this flow.

Returns:The version_count of this VersionedFlow.
Return type:int

nipyapi.nifi.models.versioned_flow_coordinates 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_coordinates.VersionedFlowCoordinates(registry_url=None, bucket_id=None, flow_id=None, version=None, latest=None)[source]

Bases: object

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

VersionedFlowCoordinates - a model defined in Swagger

attribute_map = {'bucket_id': 'bucketId', 'flow_id': 'flowId', 'latest': 'latest', 'registry_url': 'registryUrl', 'version': 'version'}
bucket_id

Gets the bucket_id of this VersionedFlowCoordinates. The UUID of the bucket that the flow resides in

Returns:The bucket_id of this VersionedFlowCoordinates.
Return type:str
flow_id

Gets the flow_id of this VersionedFlowCoordinates. The UUID of the flow

Returns:The flow_id of this VersionedFlowCoordinates.
Return type:str
latest

Gets the latest of this VersionedFlowCoordinates. Whether or not these coordinates point to the latest version of the flow

Returns:The latest of this VersionedFlowCoordinates.
Return type:bool
registry_url

Gets the registry_url of this VersionedFlowCoordinates. The URL of the Flow Registry that contains the flow

Returns:The registry_url of this VersionedFlowCoordinates.
Return type:str
swagger_types = {'bucket_id': 'str', 'flow_id': 'str', 'latest': 'bool', 'registry_url': 'str', 'version': 'int'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

version

Gets the version of this VersionedFlowCoordinates. The version of the flow

Returns:The version of this VersionedFlowCoordinates.
Return type:int

nipyapi.nifi.models.versioned_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_dto.VersionedFlowDTO(registry_id=None, bucket_id=None, flow_id=None, flow_name=None, description=None, comments=None, action=None)[source]

Bases: object

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

VersionedFlowDTO - a model defined in Swagger

action

Gets the action of this VersionedFlowDTO. The action being performed

Returns:The action of this VersionedFlowDTO.
Return type:str
attribute_map = {'action': 'action', 'bucket_id': 'bucketId', 'comments': 'comments', 'description': 'description', 'flow_id': 'flowId', 'flow_name': 'flowName', 'registry_id': 'registryId'}
bucket_id

Gets the bucket_id of this VersionedFlowDTO. The ID of the bucket where the flow is stored

Returns:The bucket_id of this VersionedFlowDTO.
Return type:str
comments

Gets the comments of this VersionedFlowDTO. Comments for the changeset

Returns:The comments of this VersionedFlowDTO.
Return type:str
description

Gets the description of this VersionedFlowDTO. A description of the flow

Returns:The description of this VersionedFlowDTO.
Return type:str
flow_id

Gets the flow_id of this VersionedFlowDTO. The ID of the flow

Returns:The flow_id of this VersionedFlowDTO.
Return type:str
flow_name

Gets the flow_name of this VersionedFlowDTO. The name of the flow

Returns:The flow_name of this VersionedFlowDTO.
Return type:str
registry_id

Gets the registry_id of this VersionedFlowDTO. The ID of the registry that the flow is tracked to

Returns:The registry_id of this VersionedFlowDTO.
Return type:str
swagger_types = {'action': 'str', 'bucket_id': 'str', 'comments': 'str', 'description': 'str', 'flow_id': 'str', 'flow_name': 'str', 'registry_id': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.versioned_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_entity.VersionedFlowEntity(versioned_flow=None)[source]

Bases: object

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

VersionedFlowEntity - a model defined in Swagger

attribute_map = {'versioned_flow': 'versionedFlow'}
swagger_types = {'versioned_flow': 'VersionedFlowDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

versioned_flow

Gets the versioned_flow of this VersionedFlowEntity. The versioned flow

Returns:The versioned_flow of this VersionedFlowEntity.
Return type:VersionedFlowDTO

nipyapi.nifi.models.versioned_flow_snapshot 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot.VersionedFlowSnapshot(snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None)[source]

Bases: object

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

VersionedFlowSnapshot - a model defined in Swagger

attribute_map = {'bucket': 'bucket', 'external_controller_services': 'externalControllerServices', 'flow': 'flow', 'flow_contents': 'flowContents', 'flow_encoding_version': 'flowEncodingVersion', 'latest': 'latest', 'parameter_contexts': 'parameterContexts', 'snapshot_metadata': 'snapshotMetadata'}
bucket

Gets the bucket of this VersionedFlowSnapshot. The bucket where the flow is located

Returns:The bucket of this VersionedFlowSnapshot.
Return type:Bucket
external_controller_services

Gets the external_controller_services of this VersionedFlowSnapshot. The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.

Returns:The external_controller_services of this VersionedFlowSnapshot.
Return type:dict(str, ExternalControllerServiceReference)
flow

Gets the flow of this VersionedFlowSnapshot. The flow this snapshot is for

Returns:The flow of this VersionedFlowSnapshot.
Return type:VersionedFlow
flow_contents

Gets the flow_contents of this VersionedFlowSnapshot. The contents of the versioned flow

Returns:The flow_contents of this VersionedFlowSnapshot.
Return type:VersionedProcessGroup
flow_encoding_version

Gets the flow_encoding_version of this VersionedFlowSnapshot. The optional encoding version of the flow contents.

Returns:The flow_encoding_version of this VersionedFlowSnapshot.
Return type:str
latest

Gets the latest of this VersionedFlowSnapshot.

Returns:The latest of this VersionedFlowSnapshot.
Return type:bool
parameter_contexts

Gets the parameter_contexts of this VersionedFlowSnapshot. The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.

Returns:The parameter_contexts of this VersionedFlowSnapshot.
Return type:dict(str, VersionedParameterContext)
snapshot_metadata

Gets the snapshot_metadata of this VersionedFlowSnapshot. The metadata for this snapshot

Returns:The snapshot_metadata of this VersionedFlowSnapshot.
Return type:VersionedFlowSnapshotMetadata
swagger_types = {'bucket': 'Bucket', 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', 'flow': 'VersionedFlow', 'flow_contents': 'VersionedProcessGroup', 'flow_encoding_version': 'str', 'latest': 'bool', 'parameter_contexts': 'dict(str, VersionedParameterContext)', 'snapshot_metadata': 'VersionedFlowSnapshotMetadata'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.versioned_flow_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot_entity.VersionedFlowSnapshotEntity(versioned_flow_snapshot=None, process_group_revision=None, registry_id=None, update_descendant_versioned_flows=None, disconnected_node_acknowledged=None)[source]

Bases: object

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

VersionedFlowSnapshotEntity - a model defined in Swagger

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'registry_id': 'registryId', 'update_descendant_versioned_flows': 'updateDescendantVersionedFlows', 'versioned_flow_snapshot': 'versionedFlowSnapshot'}
disconnected_node_acknowledged

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

Returns:The disconnected_node_acknowledged of this VersionedFlowSnapshotEntity.
Return type:bool
process_group_revision

Gets the process_group_revision of this VersionedFlowSnapshotEntity. The Revision of the Process Group under Version Control

Returns:The process_group_revision of this VersionedFlowSnapshotEntity.
Return type:RevisionDTO
registry_id

Gets the registry_id of this VersionedFlowSnapshotEntity. The ID of the Registry that this flow belongs to

Returns:The registry_id of this VersionedFlowSnapshotEntity.
Return type:str
swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'registry_id': 'str', 'update_descendant_versioned_flows': 'bool', 'versioned_flow_snapshot': 'VersionedFlowSnapshot'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

update_descendant_versioned_flows

Gets the update_descendant_versioned_flows of this VersionedFlowSnapshotEntity. If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated.

Returns:The update_descendant_versioned_flows of this VersionedFlowSnapshotEntity.
Return type:bool
versioned_flow_snapshot

Gets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity. The versioned flow snapshot

Returns:The versioned_flow_snapshot of this VersionedFlowSnapshotEntity.
Return type:VersionedFlowSnapshot

nipyapi.nifi.models.versioned_flow_snapshot_metadata_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot_metadata_entity.VersionedFlowSnapshotMetadataEntity(versioned_flow_snapshot_metadata=None, registry_id=None)[source]

Bases: object

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

VersionedFlowSnapshotMetadataEntity - a model defined in Swagger

attribute_map = {'registry_id': 'registryId', 'versioned_flow_snapshot_metadata': 'versionedFlowSnapshotMetadata'}
registry_id

Gets the registry_id of this VersionedFlowSnapshotMetadataEntity. The ID of the Registry that this flow belongs to

Returns:The registry_id of this VersionedFlowSnapshotMetadataEntity.
Return type:str
swagger_types = {'registry_id': 'str', 'versioned_flow_snapshot_metadata': 'VersionedFlowSnapshotMetadata'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

versioned_flow_snapshot_metadata

Gets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity. The collection of versioned flow snapshot metadata

Returns:The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity.
Return type:VersionedFlowSnapshotMetadata

nipyapi.nifi.models.versioned_flow_snapshot_metadata_set_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_snapshot_metadata_set_entity.VersionedFlowSnapshotMetadataSetEntity(versioned_flow_snapshot_metadata_set=None)[source]

Bases: object

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

VersionedFlowSnapshotMetadataSetEntity - a model defined in Swagger

attribute_map = {'versioned_flow_snapshot_metadata_set': 'versionedFlowSnapshotMetadataSet'}
swagger_types = {'versioned_flow_snapshot_metadata_set': 'list[VersionedFlowSnapshotMetadataEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

versioned_flow_snapshot_metadata_set

Gets the versioned_flow_snapshot_metadata_set of this VersionedFlowSnapshotMetadataSetEntity.

Returns:The versioned_flow_snapshot_metadata_set of this VersionedFlowSnapshotMetadataSetEntity.
Return type:list[VersionedFlowSnapshotMetadataEntity]

nipyapi.nifi.models.versioned_flow_update_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_update_request_dto.VersionedFlowUpdateRequestDTO(request_id=None, process_group_id=None, uri=None, last_updated=None, complete=None, failure_reason=None, percent_completed=None, state=None, version_control_information=None)[source]

Bases: object

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

VersionedFlowUpdateRequestDTO - a model defined in Swagger

attribute_map = {'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'percent_completed': 'percentCompleted', 'process_group_id': 'processGroupId', 'request_id': 'requestId', 'state': 'state', 'uri': 'uri', 'version_control_information': 'versionControlInformation'}
complete

Gets the complete of this VersionedFlowUpdateRequestDTO. Whether or not this request has completed

Returns:The complete of this VersionedFlowUpdateRequestDTO.
Return type:bool
failure_reason

Gets the failure_reason of this VersionedFlowUpdateRequestDTO. An explanation of why this request failed, or null if this request has not failed

Returns:The failure_reason of this VersionedFlowUpdateRequestDTO.
Return type:str
last_updated

Gets the last_updated of this VersionedFlowUpdateRequestDTO. The last time this request was updated.

Returns:The last_updated of this VersionedFlowUpdateRequestDTO.
Return type:str
percent_completed

Gets the percent_completed of this VersionedFlowUpdateRequestDTO. The percentage complete for the request, between 0 and 100

Returns:The percent_completed of this VersionedFlowUpdateRequestDTO.
Return type:int
process_group_id

Gets the process_group_id of this VersionedFlowUpdateRequestDTO. The unique ID of the Process Group that the variable registry belongs to

Returns:The process_group_id of this VersionedFlowUpdateRequestDTO.
Return type:str
request_id

Gets the request_id of this VersionedFlowUpdateRequestDTO. The unique ID of this request.

Returns:The request_id of this VersionedFlowUpdateRequestDTO.
Return type:str
state

Gets the state of this VersionedFlowUpdateRequestDTO. The state of the request

Returns:The state of this VersionedFlowUpdateRequestDTO.
Return type:str
swagger_types = {'complete': 'bool', 'failure_reason': 'str', 'last_updated': 'str', 'percent_completed': 'int', 'process_group_id': 'str', 'request_id': 'str', 'state': 'str', 'uri': 'str', 'version_control_information': 'VersionControlInformationDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

uri

Gets the uri of this VersionedFlowUpdateRequestDTO. The URI for future requests to this drop request.

Returns:The uri of this VersionedFlowUpdateRequestDTO.
Return type:str
version_control_information

Gets the version_control_information of this VersionedFlowUpdateRequestDTO. The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed.

Returns:The version_control_information of this VersionedFlowUpdateRequestDTO.
Return type:VersionControlInformationDTO

nipyapi.nifi.models.versioned_flow_update_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flow_update_request_entity.VersionedFlowUpdateRequestEntity(request=None, process_group_revision=None)[source]

Bases: object

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

VersionedFlowUpdateRequestEntity - a model defined in Swagger

attribute_map = {'process_group_revision': 'processGroupRevision', 'request': 'request'}
process_group_revision

Gets the process_group_revision of this VersionedFlowUpdateRequestEntity. The revision for the Process Group that owns this variable registry.

Returns:The process_group_revision of this VersionedFlowUpdateRequestEntity.
Return type:RevisionDTO
request

Gets the request of this VersionedFlowUpdateRequestEntity. The Versioned Flow Update Request

Returns:The request of this VersionedFlowUpdateRequestEntity.
Return type:VersionedFlowUpdateRequestDTO
swagger_types = {'process_group_revision': 'RevisionDTO', 'request': 'VersionedFlowUpdateRequestDTO'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.versioned_flows_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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_flows_entity.VersionedFlowsEntity(versioned_flows=None)[source]

Bases: object

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

VersionedFlowsEntity - a model defined in Swagger

attribute_map = {'versioned_flows': 'versionedFlows'}
swagger_types = {'versioned_flows': 'list[VersionedFlowEntity]'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

versioned_flows

Gets the versioned_flows of this VersionedFlowsEntity.

Returns:The versioned_flows of this VersionedFlowsEntity.
Return type:list[VersionedFlowEntity]

nipyapi.nifi.models.versioned_funnel 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_funnel.VersionedFunnel(identifier=None, name=None, comments=None, position=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedFunnel - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'name': 'name', 'position': 'position'}
comments

Gets the comments of this VersionedFunnel. The user-supplied comments for the component

Returns:The comments of this VersionedFunnel.
Return type:str
component_type

Gets the component_type of this VersionedFunnel.

Returns:The component_type of this VersionedFunnel.
Return type:str
group_identifier

Gets the group_identifier of this VersionedFunnel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedFunnel.
Return type:str
identifier

Gets the identifier of this VersionedFunnel. The component’s unique identifier

Returns:The identifier of this VersionedFunnel.
Return type:str
name

Gets the name of this VersionedFunnel. The component’s name

Returns:The name of this VersionedFunnel.
Return type:str
position

Gets the position of this VersionedFunnel. The component’s position on the graph

Returns:The position of this VersionedFunnel.
Return type:Position
swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'name': 'str', 'position': 'Position'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.versioned_label 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_label.VersionedLabel(identifier=None, name=None, comments=None, position=None, label=None, width=None, height=None, style=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedLabel - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'height': 'height', 'identifier': 'identifier', 'label': 'label', 'name': 'name', 'position': 'position', 'style': 'style', 'width': 'width'}
comments

Gets the comments of this VersionedLabel. The user-supplied comments for the component

Returns:The comments of this VersionedLabel.
Return type:str
component_type

Gets the component_type of this VersionedLabel.

Returns:The component_type of this VersionedLabel.
Return type:str
group_identifier

Gets the group_identifier of this VersionedLabel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedLabel.
Return type:str
height

Gets the height of this VersionedLabel. The height of the label in pixels when at a 1:1 scale.

Returns:The height of this VersionedLabel.
Return type:float
identifier

Gets the identifier of this VersionedLabel. The component’s unique identifier

Returns:The identifier of this VersionedLabel.
Return type:str
label

Gets the label of this VersionedLabel. The text that appears in the label.

Returns:The label of this VersionedLabel.
Return type:str
name

Gets the name of this VersionedLabel. The component’s name

Returns:The name of this VersionedLabel.
Return type:str
position

Gets the position of this VersionedLabel. The component’s position on the graph

Returns:The position of this VersionedLabel.
Return type:Position
style

Gets the style of this VersionedLabel. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:The style of this VersionedLabel.
Return type:dict(str, str)
swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'height': 'float', 'identifier': 'str', 'label': 'str', 'name': 'str', 'position': 'Position', 'style': 'dict(str, str)', 'width': 'float'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

width

Gets the width of this VersionedLabel. The width of the label in pixels when at a 1:1 scale.

Returns:The width of this VersionedLabel.
Return type:float

nipyapi.nifi.models.versioned_port 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_port.VersionedPort(identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, scheduled_state=None, allow_remote_access=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedPort - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this VersionedPort. Whether or not this port allows remote access for site-to-site

Returns:The allow_remote_access of this VersionedPort.
Return type:bool
attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'name': 'name', 'position': 'position', 'scheduled_state': 'scheduledState', 'type': 'type'}
comments

Gets the comments of this VersionedPort. The user-supplied comments for the component

Returns:The comments of this VersionedPort.
Return type:str
component_type

Gets the component_type of this VersionedPort.

Returns:The component_type of this VersionedPort.
Return type:str
concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedPort. The number of tasks that should be concurrently scheduled for the port.

Returns:The concurrently_schedulable_task_count of this VersionedPort.
Return type:int
group_identifier

Gets the group_identifier of this VersionedPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedPort.
Return type:str
identifier

Gets the identifier of this VersionedPort. The component’s unique identifier

Returns:The identifier of this VersionedPort.
Return type:str
name

Gets the name of this VersionedPort. The component’s name

Returns:The name of this VersionedPort.
Return type:str
position

Gets the position of this VersionedPort. The component’s position on the graph

Returns:The position of this VersionedPort.
Return type:Position
scheduled_state

Gets the scheduled_state of this VersionedPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedPort.
Return type:str
swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'name': 'str', 'position': 'Position', 'scheduled_state': 'str', 'type': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this VersionedPort. The type of port.

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

nipyapi.nifi.models.versioned_process_group 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_process_group.VersionedProcessGroup(identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedProcessGroup - a model defined in Swagger

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'connections': 'connections', 'controller_services': 'controllerServices', 'funnels': 'funnels', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'labels': 'labels', 'name': 'name', 'output_ports': 'outputPorts', 'parameter_context_name': 'parameterContextName', 'position': 'position', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'variables': 'variables', 'versioned_flow_coordinates': 'versionedFlowCoordinates'}
comments

Gets the comments of this VersionedProcessGroup. The user-supplied comments for the component

Returns:The comments of this VersionedProcessGroup.
Return type:str
component_type

Gets the component_type of this VersionedProcessGroup.

Returns:The component_type of this VersionedProcessGroup.
Return type:str
connections

Gets the connections of this VersionedProcessGroup. The Connections

Returns:The connections of this VersionedProcessGroup.
Return type:list[VersionedConnection]
controller_services

Gets the controller_services of this VersionedProcessGroup. The Controller Services

Returns:The controller_services of this VersionedProcessGroup.
Return type:list[VersionedControllerService]
funnels

Gets the funnels of this VersionedProcessGroup. The Funnels

Returns:The funnels of this VersionedProcessGroup.
Return type:list[VersionedFunnel]
group_identifier

Gets the group_identifier of this VersionedProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessGroup.
Return type:str
identifier

Gets the identifier of this VersionedProcessGroup. The component’s unique identifier

Returns:The identifier of this VersionedProcessGroup.
Return type:str
input_ports

Gets the input_ports of this VersionedProcessGroup. The Input Ports

Returns:The input_ports of this VersionedProcessGroup.
Return type:list[VersionedPort]
labels

Gets the labels of this VersionedProcessGroup. The Labels

Returns:The labels of this VersionedProcessGroup.
Return type:list[VersionedLabel]
name

Gets the name of this VersionedProcessGroup. The component’s name

Returns:The name of this VersionedProcessGroup.
Return type:str
output_ports

Gets the output_ports of this VersionedProcessGroup. The Output Ports

Returns:The output_ports of this VersionedProcessGroup.
Return type:list[VersionedPort]
parameter_context_name

Gets the parameter_context_name of this VersionedProcessGroup. The name of the parameter context used by this process group

Returns:The parameter_context_name of this VersionedProcessGroup.
Return type:str
position

Gets the position of this VersionedProcessGroup. The component’s position on the graph

Returns:The position of this VersionedProcessGroup.
Return type:Position
process_groups

Gets the process_groups of this VersionedProcessGroup. The child Process Groups

Returns:The process_groups of this VersionedProcessGroup.
Return type:list[VersionedProcessGroup]
processors

Gets the processors of this VersionedProcessGroup. The Processors

Returns:The processors of this VersionedProcessGroup.
Return type:list[VersionedProcessor]
remote_process_groups

Gets the remote_process_groups of this VersionedProcessGroup. The Remote Process Groups

Returns:The remote_process_groups of this VersionedProcessGroup.
Return type:list[VersionedRemoteProcessGroup]
swagger_types = {'comments': 'str', 'component_type': 'str', 'connections': 'list[VersionedConnection]', 'controller_services': 'list[VersionedControllerService]', 'funnels': 'list[VersionedFunnel]', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedPort]', 'labels': 'list[VersionedLabel]', 'name': 'str', 'output_ports': 'list[VersionedPort]', 'parameter_context_name': 'str', 'position': 'Position', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', 'variables': 'dict(str, str)', 'versioned_flow_coordinates': 'VersionedFlowCoordinates'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

variables

Gets the variables of this VersionedProcessGroup. The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)

Returns:The variables of this VersionedProcessGroup.
Return type:dict(str, str)
versioned_flow_coordinates

Gets the versioned_flow_coordinates of this VersionedProcessGroup. The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control

Returns:The versioned_flow_coordinates of this VersionedProcessGroup.
Return type:VersionedFlowCoordinates

nipyapi.nifi.models.versioned_processor 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_processor.VersionedProcessor(identifier=None, name=None, comments=None, position=None, bundle=None, style=None, type=None, properties=None, property_descriptors=None, annotation_data=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, scheduled_state=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedProcessor - a model defined in Swagger

annotation_data

Gets the annotation_data of this VersionedProcessor. The annotation data for the processor used to relay configuration between a custom UI and the procesosr.

Returns:The annotation_data of this VersionedProcessor.
Return type:str
attribute_map = {'annotation_data': 'annotationData', 'auto_terminated_relationships': 'autoTerminatedRelationships', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'execution_node': 'executionNode', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'name': 'name', 'penalty_duration': 'penaltyDuration', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'run_duration_millis': 'runDurationMillis', 'scheduled_state': 'scheduledState', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'style': 'style', 'type': 'type', 'yield_duration': 'yieldDuration'}
auto_terminated_relationships

Gets the auto_terminated_relationships of this VersionedProcessor. The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the ‘isAutoTerminate’ property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.

Returns:The auto_terminated_relationships of this VersionedProcessor.
Return type:list[str]
bulletin_level

Gets the bulletin_level of this VersionedProcessor. The level at which the processor will report bulletins.

Returns:The bulletin_level of this VersionedProcessor.
Return type:str
bundle

Gets the bundle of this VersionedProcessor. Information about the bundle from which the component came

Returns:The bundle of this VersionedProcessor.
Return type:Bundle
comments

Gets the comments of this VersionedProcessor. The user-supplied comments for the component

Returns:The comments of this VersionedProcessor.
Return type:str
component_type

Gets the component_type of this VersionedProcessor.

Returns:The component_type of this VersionedProcessor.
Return type:str
concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedProcessor. The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.

Returns:The concurrently_schedulable_task_count of this VersionedProcessor.
Return type:int
execution_node

Gets the execution_node of this VersionedProcessor. Indicates the node where the process will execute.

Returns:The execution_node of this VersionedProcessor.
Return type:str
group_identifier

Gets the group_identifier of this VersionedProcessor. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessor.
Return type:str
identifier

Gets the identifier of this VersionedProcessor. The component’s unique identifier

Returns:The identifier of this VersionedProcessor.
Return type:str
name

Gets the name of this VersionedProcessor. The component’s name

Returns:The name of this VersionedProcessor.
Return type:str
penalty_duration

Gets the penalty_duration of this VersionedProcessor. The amout of time that is used when the process penalizes a flowfile.

Returns:The penalty_duration of this VersionedProcessor.
Return type:str
position

Gets the position of this VersionedProcessor. The component’s position on the graph

Returns:The position of this VersionedProcessor.
Return type:Position
properties

Gets the properties of this VersionedProcessor. The properties for the processor. Properties whose value is not set will only contain the property name.

Returns:The properties of this VersionedProcessor.
Return type:dict(str, str)
property_descriptors

Gets the property_descriptors of this VersionedProcessor. The property descriptors for the processor.

Returns:The property_descriptors of this VersionedProcessor.
Return type:dict(str, VersionedPropertyDescriptor)
run_duration_millis

Gets the run_duration_millis of this VersionedProcessor. The run duration for the processor in milliseconds.

Returns:The run_duration_millis of this VersionedProcessor.
Return type:int
scheduled_state

Gets the scheduled_state of this VersionedProcessor. The scheduled state of the component

Returns:The scheduled_state of this VersionedProcessor.
Return type:str
scheduling_period

Gets the scheduling_period of this VersionedProcessor. The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.

Returns:The scheduling_period of this VersionedProcessor.
Return type:str
scheduling_strategy

Gets the scheduling_strategy of this VersionedProcessor. Indcates whether the prcessor should be scheduled to run in event or timer driven mode.

Returns:The scheduling_strategy of this VersionedProcessor.
Return type:str
style

Gets the style of this VersionedProcessor. Stylistic data for rendering in a UI

Returns:The style of this VersionedProcessor.
Return type:dict(str, str)
swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'execution_node': 'str', 'group_identifier': 'str', 'identifier': 'str', 'name': 'str', 'penalty_duration': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'run_duration_millis': 'int', 'scheduled_state': 'str', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'style': 'dict(str, str)', 'type': 'str', 'yield_duration': 'str'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

type

Gets the type of this VersionedProcessor. The type of Processor

Returns:The type of this VersionedProcessor.
Return type:str
yield_duration

Gets the yield_duration of this VersionedProcessor. The amount of time that must elapse before this processor is scheduled again after yielding.

Returns:The yield_duration of this VersionedProcessor.
Return type:str

nipyapi.nifi.models.versioned_property_descriptor 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_property_descriptor.VersionedPropertyDescriptor(name=None, display_name=None, identifies_controller_service=None, sensitive=None)[source]

Bases: object

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

VersionedPropertyDescriptor - a model defined in Swagger

attribute_map = {'display_name': 'displayName', 'identifies_controller_service': 'identifiesControllerService', 'name': 'name', 'sensitive': 'sensitive'}
display_name

Gets the display_name of this VersionedPropertyDescriptor. The display name of the property

Returns:The display_name of this VersionedPropertyDescriptor.
Return type:str
identifies_controller_service

Gets the identifies_controller_service of this VersionedPropertyDescriptor. Whether or not the property provides the identifier of a Controller Service

Returns:The identifies_controller_service of this VersionedPropertyDescriptor.
Return type:bool
name

Gets the name of this VersionedPropertyDescriptor. The name of the property

Returns:The name of this VersionedPropertyDescriptor.
Return type:str
sensitive

Gets the sensitive of this VersionedPropertyDescriptor. Whether or not the property is considered sensitive

Returns:The sensitive of this VersionedPropertyDescriptor.
Return type:bool
swagger_types = {'display_name': 'str', 'identifies_controller_service': 'bool', 'name': 'str', 'sensitive': 'bool'}
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

nipyapi.nifi.models.versioned_remote_group_port 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_remote_group_port.VersionedRemoteGroupPort(identifier=None, name=None, comments=None, position=None, remote_group_id=None, concurrently_schedulable_task_count=None, use_compression=None, batch_size=None, component_type=None, target_id=None, scheduled_state=None, group_identifier=None)[source]

Bases: object

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

VersionedRemoteGroupPort - a model defined in Swagger

attribute_map = {'batch_size': 'batchSize', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'name': 'name', 'position': 'position', 'remote_group_id': 'remoteGroupId', 'scheduled_state': 'scheduledState', 'target_id': 'targetId', 'use_compression': 'useCompression'}
batch_size

Gets the batch_size of this VersionedRemoteGroupPort. The batch settings for data transmission.

Returns:The batch_size of this VersionedRemoteGroupPort.
Return type:BatchSize
comments

Gets the comments of this VersionedRemoteGroupPort. The user-supplied comments for the component

Returns:The comments of this VersionedRemoteGroupPort.
Return type:str
component_type

Gets the component_type of this VersionedRemoteGroupPort.

Returns:The component_type of this VersionedRemoteGroupPort.
Return type:str
concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. The number of task that may transmit flowfiles to the target port concurrently.

Returns:The concurrently_schedulable_task_count of this VersionedRemoteGroupPort.
Return type:int
group_identifier

Gets the group_identifier of this VersionedRemoteGroupPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteGroupPort.
Return type:str
identifier

Gets the identifier of this VersionedRemoteGroupPort. The component’s unique identifier

Returns:The identifier of this VersionedRemoteGroupPort.
Return type:str
name

Gets the name of this VersionedRemoteGroupPort. The component’s name

Returns:The name of this VersionedRemoteGroupPort.
Return type:str
position

Gets the position of this VersionedRemoteGroupPort. The component’s position on the graph

Returns:The position of this VersionedRemoteGroupPort.
Return type:Position
remote_group_id

Gets the remote_group_id of this VersionedRemoteGroupPort. The id of the remote process group that the port resides in.

Returns:The remote_group_id of this VersionedRemoteGroupPort.
Return type:str
scheduled_state

Gets the scheduled_state of this VersionedRemoteGroupPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedRemoteGroupPort.
Return type:str
swagger_types = {'batch_size': 'BatchSize', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'name': 'str', 'position': 'Position', 'remote_group_id': 'str', 'scheduled_state': 'str', 'target_id': 'str', 'use_compression': 'bool'}
target_id

Gets the target_id of this VersionedRemoteGroupPort. The ID of the port on the target NiFi instance

Returns:The target_id of this VersionedRemoteGroupPort.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

use_compression

Gets the use_compression of this VersionedRemoteGroupPort. Whether the flowfiles are compressed when sent to the target port.

Returns:The use_compression of this VersionedRemoteGroupPort.
Return type:bool

nipyapi.nifi.models.versioned_remote_process_group 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.11.1-SNAPSHOT Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.models.versioned_remote_process_group.VersionedRemoteProcessGroup(identifier=None, name=None, comments=None, position=None, target_uri=None, target_uris=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, input_ports=None, output_ports=None, component_type=None, group_identifier=None)[source]

Bases: object

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

VersionedRemoteProcessGroup - a model defined in Swagger

attribute_map = {'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_ports': 'outputPorts', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_uri': 'targetUri', 'target_uris': 'targetUris', 'transport_protocol': 'transportProtocol', 'yield_duration': 'yieldDuration'}
comments

Gets the comments of this VersionedRemoteProcessGroup. The user-supplied comments for the component

Returns:The comments of this VersionedRemoteProcessGroup.
Return type:str
communications_timeout

Gets the communications_timeout of this VersionedRemoteProcessGroup. The time period used for the timeout when communicating with the target.

Returns:The communications_timeout of this VersionedRemoteProcessGroup.
Return type:str
component_type

Gets the component_type of this VersionedRemoteProcessGroup.

Returns:The component_type of this VersionedRemoteProcessGroup.
Return type:str
group_identifier

Gets the group_identifier of this VersionedRemoteProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteProcessGroup.
Return type:str
identifier

Gets the identifier of this VersionedRemoteProcessGroup. The component’s unique identifier

Returns:The identifier of this VersionedRemoteProcessGroup.
Return type:str
input_ports

Gets the input_ports of this VersionedRemoteProcessGroup. A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance

Returns:The input_ports of this VersionedRemoteProcessGroup.
Return type:list[VersionedRemoteGroupPort]
local_network_interface

Gets the local_network_interface of this VersionedRemoteProcessGroup. The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.

Returns:The local_network_interface of this VersionedRemoteProcessGroup.
Return type:str
name

Gets the name of this VersionedRemoteProcessGroup. The component’s name

Returns:The name of this VersionedRemoteProcessGroup.
Return type:str
output_ports

Gets the output_ports of this VersionedRemoteProcessGroup. A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance

Returns:The output_ports of this VersionedRemoteProcessGroup.
Return type:list[VersionedRemoteGroupPort]
position

Gets the position of this VersionedRemoteProcessGroup. The component’s position on the graph

Returns:The position of this VersionedRemoteProcessGroup.
Return type:Position
proxy_host

Gets the proxy_host of this VersionedRemoteProcessGroup.

Returns:The proxy_host of this VersionedRemoteProcessGroup.
Return type:str
proxy_port

Gets the proxy_port of this VersionedRemoteProcessGroup.

Returns:The proxy_port of this VersionedRemoteProcessGroup.
Return type:int
proxy_user

Gets the proxy_user of this VersionedRemoteProcessGroup.

Returns:The proxy_user of this VersionedRemoteProcessGroup.
Return type:str
swagger_types = {'comments': 'str', 'communications_timeout': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedRemoteGroupPort]', 'local_network_interface': 'str', 'name': 'str', 'output_ports': 'list[VersionedRemoteGroupPort]', 'position': 'Position', 'proxy_host': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_uri': 'str', 'target_uris': 'str', 'transport_protocol': 'str', 'yield_duration': 'str'}
target_uri

Gets the target_uri of this VersionedRemoteProcessGroup. [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.

Returns:The target_uri of this VersionedRemoteProcessGroup.
Return type:str
target_uris

Gets the target_uris of this VersionedRemoteProcessGroup. The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.

Returns:The target_uris of this VersionedRemoteProcessGroup.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

transport_protocol

Gets the transport_protocol of this VersionedRemoteProcessGroup. The Transport Protocol that is used for Site-to-Site communications

Returns:The transport_protocol of this VersionedRemoteProcessGroup.
Return type:str
yield_duration

Gets the yield_duration of this VersionedRemoteProcessGroup. When yielding, this amount of time must elapse before the remote process group is scheduled again.

Returns:The yield_duration of this VersionedRemoteProcessGroup.
Return type:str