NiFi Models

Complete model class reference for NiFi APIs.

This reference documents all 394 model classes used by NiFi APIs. These classes are automatically cross-referenced from API documentation - click any model type in API documentation to jump directly to its definition here.

Model Type Patterns

Entity Classes (e.g., ProcessGroupEntity): Complete API objects with metadata and revision information

DTO Classes (e.g., ProcessGroupDTO): Core data transfer objects containing the essential properties

Status Classes (e.g., ProcessGroupStatus): Runtime status and statistics for monitoring

Configuration Classes: Settings, parameters, and configuration objects

All Model Classes

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

Bases: object

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

AboutDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(build_branch=None, build_revision=None, build_tag=None, build_timestamp=None, content_viewer_url=None, timezone=None, title=None, uri=None, version=None)

AboutDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property build_branch

Gets the build_branch of this AboutDTO. Build branch

Returns:

The build_branch of this AboutDTO.

Return type:

str

property build_revision

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

Returns:

The build_revision of this AboutDTO.

Return type:

str

property build_tag

Gets the build_tag of this AboutDTO. Build tag

Returns:

The build_tag of this AboutDTO.

Return type:

str

property build_timestamp

Gets the build_timestamp of this AboutDTO. Build timestamp

Returns:

The build_timestamp of this AboutDTO.

Return type:

str

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

property timezone

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

Returns:

The timezone of this AboutDTO.

Return type:

str

property title

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

Returns:

The title of this AboutDTO.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this AboutDTO.

Return type:

str

property version

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

Returns:

The version of this AboutDTO.

Return type:

str

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

Bases: object

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

AboutEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(about=None)

AboutEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property about

Gets the about of this AboutEntity.

Returns:

The about of this AboutEntity.

Return type:

AboutDTO

attribute_map = {'about': 'about'}

swagger_types = {'about': 'AboutDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

AccessPolicyDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(action=None, component_reference=None, configurable=None, id=None, parent_group_id=None, position=None, resource=None, user_groups=None, users=None, versioned_component_id=None)

AccessPolicyDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component_reference

Gets the component_reference of this AccessPolicyDTO.

Returns:

The component_reference of this AccessPolicyDTO.

Return type:

ComponentReferenceEntity

property configurable

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

Returns:

The configurable of this AccessPolicyDTO.

Return type:

bool

property id

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

Returns:

The id of this AccessPolicyDTO.

Return type:

str

property 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

property position

Gets the position of this AccessPolicyDTO.

Returns:

The position of this AccessPolicyDTO.

Return type:

PositionDTO

property resource

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

Returns:

The resource of this AccessPolicyDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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]

property 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]

property 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

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

Bases: object

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

AccessPolicyEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, generated=None, id=None, permissions=None, position=None, revision=None, uri=None)

AccessPolicyEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this AccessPolicyEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this AccessPolicyEntity.

Returns:

The component of this AccessPolicyEntity.

Return type:

AccessPolicyDTO

property 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

property generated

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

Returns:

The generated of this AccessPolicyEntity.

Return type:

str

property id

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

Returns:

The id of this AccessPolicyEntity.

Return type:

str

property permissions

Gets the permissions of this AccessPolicyEntity.

Returns:

The permissions of this AccessPolicyEntity.

Return type:

PermissionsDTO

property position

Gets the position of this AccessPolicyEntity.

Returns:

The position of this AccessPolicyEntity.

Return type:

PositionDTO

property revision

Gets the revision of this AccessPolicyEntity.

Returns:

The revision of this AccessPolicyEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this AccessPolicyEntity.

Return type:

str

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

Bases: object

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

AccessPolicySummaryDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(action=None, component_reference=None, configurable=None, id=None, parent_group_id=None, position=None, resource=None, versioned_component_id=None)

AccessPolicySummaryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component_reference

Gets the component_reference of this AccessPolicySummaryDTO.

Returns:

The component_reference of this AccessPolicySummaryDTO.

Return type:

ComponentReferenceEntity

property configurable

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

Returns:

The configurable of this AccessPolicySummaryDTO.

Return type:

bool

property id

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

Returns:

The id of this AccessPolicySummaryDTO.

Return type:

str

property 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

property position

Gets the position of this AccessPolicySummaryDTO.

Returns:

The position of this AccessPolicySummaryDTO.

Return type:

PositionDTO

property resource

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

Returns:

The resource of this AccessPolicySummaryDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

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

Bases: object

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

AccessPolicySummaryEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

AccessPolicySummaryEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this AccessPolicySummaryEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this AccessPolicySummaryEntity.

Returns:

The component of this AccessPolicySummaryEntity.

Return type:

AccessPolicySummaryDTO

property 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

property id

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

Returns:

The id of this AccessPolicySummaryEntity.

Return type:

str

property permissions

Gets the permissions of this AccessPolicySummaryEntity.

Returns:

The permissions of this AccessPolicySummaryEntity.

Return type:

PermissionsDTO

property position

Gets the position of this AccessPolicySummaryEntity.

Returns:

The position of this AccessPolicySummaryEntity.

Return type:

PositionDTO

property revision

Gets the revision of this AccessPolicySummaryEntity.

Returns:

The revision of this AccessPolicySummaryEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this AccessPolicySummaryEntity.

Return type:

str

class nipyapi.nifi.models.AccessTokenBody(password=None, username=None)

Bases: object

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

AccessTokenBody - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(password=None, username=None)

AccessTokenBody - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'password': 'password', 'username': 'username'}

property password

Gets the password of this AccessTokenBody.

Returns:

The password of this AccessTokenBody.

Return type:

str

swagger_types = {'password': 'str', 'username': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property username

Gets the username of this AccessTokenBody.

Returns:

The username of this AccessTokenBody.

Return type:

str

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

Bases: object

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

ActionDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(action_details=None, component_details=None, id=None, operation=None, source_id=None, source_name=None, source_type=None, timestamp=None, user_identity=None)

ActionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property action_details

Gets the action_details of this ActionDTO.

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

property component_details

Gets the component_details of this ActionDTO.

Returns:

The component_details of this ActionDTO.

Return type:

ComponentDetailsDTO

property id

Gets the id of this ActionDTO. The action id.

Returns:

The id of this ActionDTO.

Return type:

int

property operation

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

Returns:

The operation of this ActionDTO.

Return type:

str

property 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

property 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

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

property timestamp

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

Returns:

The timestamp of this ActionDTO.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ActionDetailsDTO

Bases: object

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

ActionDetailsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__()

ActionDetailsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ActionEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(action=None, can_read=None, id=None, source_id=None, timestamp=None)

ActionEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property id

Gets the id of this ActionEntity.

Returns:

The id of this ActionEntity.

Return type:

int

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

property timestamp

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

Returns:

The timestamp of this ActionEntity.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ActivateControllerServicesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(components=None, disconnected_node_acknowledged=None, id=None, state=None)

ActivateControllerServicesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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)

property 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

property id

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

Returns:

The id of this ActivateControllerServicesEntity.

Return type:

str

property state

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

Returns:

The state of this ActivateControllerServicesEntity.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.AdditionalDetailsEntity(additional_details=None)

Bases: object

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

AdditionalDetailsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(additional_details=None)

AdditionalDetailsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property additional_details

Gets the additional_details of this AdditionalDetailsEntity.

Returns:

The additional_details of this AdditionalDetailsEntity.

Return type:

str

attribute_map = {'additional_details': 'additionalDetails'}

swagger_types = {'additional_details': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

AffectedComponentDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, id=None, name=None, process_group_id=None, reference_type=None, state=None, validation_errors=None)

AffectedComponentDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

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

Returns:

The id of this AffectedComponentDTO.

Return type:

str

property name

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

Returns:

The name of this AffectedComponentDTO.

Return type:

str

property 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

property reference_type

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

Returns:

The reference_type of this AffectedComponentDTO.

Return type:

str

property state

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

Returns:

The state of this AffectedComponentDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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]

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

Bases: object

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

AffectedComponentEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, process_group=None, reference_type=None, revision=None, uri=None)

AffectedComponentEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this AffectedComponentEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this AffectedComponentEntity.

Returns:

The component of this AffectedComponentEntity.

Return type:

AffectedComponentDTO

property 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

property id

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

Returns:

The id of this AffectedComponentEntity.

Return type:

str

property permissions

Gets the permissions of this AffectedComponentEntity.

Returns:

The permissions of this AffectedComponentEntity.

Return type:

PermissionsDTO

property position

Gets the position of this AffectedComponentEntity.

Returns:

The position of this AffectedComponentEntity.

Return type:

PositionDTO

property process_group

Gets the process_group of this AffectedComponentEntity.

Returns:

The process_group of this AffectedComponentEntity.

Return type:

ProcessGroupNameDTO

property reference_type

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

Returns:

The reference_type of this AffectedComponentEntity.

Return type:

str

property revision

Gets the revision of this AffectedComponentEntity.

Returns:

The revision of this AffectedComponentEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this AffectedComponentEntity.

Return type:

str

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

Bases: object

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

AllowableValueDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, display_name=None, value=None)

AllowableValueDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

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

Returns:

The description of this AllowableValueDTO.

Return type:

str

property display_name

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

Returns:

The display_name of this AllowableValueDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

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

Bases: object

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

AllowableValueEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(allowable_value=None, can_read=None)

AllowableValueEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property can_read

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

Returns:

The can_read of this AllowableValueEntity.

Return type:

bool

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.AssetDTO(digest=None, id=None, missing_content=None, name=None)

Bases: object

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

AssetDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(digest=None, id=None, missing_content=None, name=None)

AssetDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'digest': 'digest', 'id': 'id', 'missing_content': 'missingContent', 'name': 'name'}

property digest

Gets the digest of this AssetDTO. The digest of the asset, will be null if the asset content is missing.

Returns:

The digest of this AssetDTO.

Return type:

str

property id

Gets the id of this AssetDTO. The identifier of the asset.

Returns:

The id of this AssetDTO.

Return type:

str

property missing_content

Gets the missing_content of this AssetDTO. Indicates if the content of the asset is missing.

Returns:

The missing_content of this AssetDTO.

Return type:

bool

property name

Gets the name of this AssetDTO. The name of the asset.

Returns:

The name of this AssetDTO.

Return type:

str

swagger_types = {'digest': 'str', 'id': 'str', 'missing_content': 'bool', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.AssetEntity(asset=None)

Bases: object

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

AssetEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(asset=None)

AssetEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property asset

Gets the asset of this AssetEntity.

Returns:

The asset of this AssetEntity.

Return type:

AssetDTO

attribute_map = {'asset': 'asset'}

swagger_types = {'asset': 'AssetDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.AssetReferenceDTO(id=None, name=None)

Bases: object

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

AssetReferenceDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None)

AssetReferenceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

Gets the id of this AssetReferenceDTO. The identifier of the referenced asset.

Returns:

The id of this AssetReferenceDTO.

Return type:

str

property name

Gets the name of this AssetReferenceDTO. The name of the referenced asset.

Returns:

The name of this AssetReferenceDTO.

Return type:

str

swagger_types = {'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.AssetsEntity(assets=None)

Bases: object

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

AssetsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(assets=None)

AssetsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property assets

Gets the assets of this AssetsEntity. The asset entities

Returns:

The assets of this AssetsEntity.

Return type:

list[AssetEntity]

attribute_map = {'assets': 'assets'}

swagger_types = {'assets': 'list[AssetEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.Attribute(description=None, name=None)

Bases: object

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

Attribute - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None)

Attribute - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this Attribute. The description of the attribute

Returns:

The description of this Attribute.

Return type:

str

property name

Gets the name of this Attribute. The name of the attribute

Returns:

The name of this Attribute.

Return type:

str

swagger_types = {'description': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

AttributeDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(name=None, previous_value=None, value=None)

AttributeDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property name

Gets the name of this AttributeDTO. The attribute name.

Returns:

The name of this AttributeDTO.

Return type:

str

property previous_value

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

Returns:

The previous_value of this AttributeDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this AttributeDTO. The attribute value.

Returns:

The value of this AttributeDTO.

Return type:

str

class nipyapi.nifi.models.AuthenticationConfigurationDTO(external_login_required=None, login_supported=None, login_uri=None, logout_uri=None)

Bases: object

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

AuthenticationConfigurationDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(external_login_required=None, login_supported=None, login_uri=None, logout_uri=None)

AuthenticationConfigurationDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'external_login_required': 'externalLoginRequired', 'login_supported': 'loginSupported', 'login_uri': 'loginUri', 'logout_uri': 'logoutUri'}

property external_login_required

Gets the external_login_required of this AuthenticationConfigurationDTO. Whether the system requires login through an external Identity Provider

Returns:

The external_login_required of this AuthenticationConfigurationDTO.

Return type:

bool

property login_supported

Gets the login_supported of this AuthenticationConfigurationDTO. Whether the system is configured to support login operations

Returns:

The login_supported of this AuthenticationConfigurationDTO.

Return type:

bool

property login_uri

Gets the login_uri of this AuthenticationConfigurationDTO. Location for initiating login processing

Returns:

The login_uri of this AuthenticationConfigurationDTO.

Return type:

str

property logout_uri

Gets the logout_uri of this AuthenticationConfigurationDTO. Location for initiating logout processing

Returns:

The logout_uri of this AuthenticationConfigurationDTO.

Return type:

str

swagger_types = {'external_login_required': 'bool', 'login_supported': 'bool', 'login_uri': 'str', 'logout_uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.AuthenticationConfigurationEntity(authentication_configuration=None)

Bases: object

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

AuthenticationConfigurationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(authentication_configuration=None)

AuthenticationConfigurationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'authentication_configuration': 'authenticationConfiguration'}

property authentication_configuration

Gets the authentication_configuration of this AuthenticationConfigurationEntity.

Returns:

The authentication_configuration of this AuthenticationConfigurationEntity.

Return type:

AuthenticationConfigurationDTO

swagger_types = {'authentication_configuration': 'AuthenticationConfigurationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BannerDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(footer_text=None, header_text=None)

BannerDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property footer_text

Gets the footer_text of this BannerDTO. The footer text.

Returns:

The footer_text of this BannerDTO.

Return type:

str

property header_text

Gets the header_text of this BannerDTO. The header text.

Returns:

The header_text of this BannerDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BannerEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(banners=None)

BannerEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'banners': 'banners'}

property banners

Gets the banners of this BannerEntity.

Returns:

The banners of this BannerEntity.

Return type:

BannerDTO

swagger_types = {'banners': 'BannerDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BatchSettingsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(count=None, duration=None, size=None)

BatchSettingsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property size

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

Returns:

The size of this BatchSettingsDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BatchSize - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(count=None, duration=None, size=None)

BatchSize - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property size

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

Returns:

The size of this BatchSize.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.BuildInfo(compiler=None, compiler_flags=None, revision=None, target_arch=None, timestamp=None, version=None)

Bases: object

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

BuildInfo - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(compiler=None, compiler_flags=None, revision=None, target_arch=None, timestamp=None, version=None)

BuildInfo - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'compiler': 'compiler', 'compiler_flags': 'compilerFlags', 'revision': 'revision', 'target_arch': 'targetArch', 'timestamp': 'timestamp', 'version': 'version'}

property compiler

Gets the compiler of this BuildInfo. The compiler used for the build

Returns:

The compiler of this BuildInfo.

Return type:

str

property compiler_flags

Gets the compiler_flags of this BuildInfo. The compiler flags used for the build.

Returns:

The compiler_flags of this BuildInfo.

Return type:

str

property revision

Gets the revision of this BuildInfo. The SCM revision id of the source code used for this build.

Returns:

The revision of this BuildInfo.

Return type:

str

swagger_types = {'compiler': 'str', 'compiler_flags': 'str', 'revision': 'str', 'target_arch': 'str', 'timestamp': 'int', 'version': 'str'}

property target_arch

Gets the target_arch of this BuildInfo. The target architecture of the built component.

Returns:

The target_arch of this BuildInfo.

Return type:

str

property timestamp

Gets the timestamp of this BuildInfo. The timestamp (milliseconds since Epoch) of the build.

Returns:

The timestamp of this BuildInfo.

Return type:

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this BuildInfo. The version number of the built component.

Returns:

The version of this BuildInfo.

Return type:

str

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

Bases: object

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

BulletinBoardDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, generated=None)

BulletinBoardDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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]

property generated

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

Returns:

The generated of this BulletinBoardDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BulletinBoardEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletin_board=None)

BulletinBoardEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bulletin_board': 'bulletinBoard'}

property bulletin_board

Gets the bulletin_board of this BulletinBoardEntity.

Returns:

The bulletin_board of this BulletinBoardEntity.

Return type:

BulletinBoardDTO

swagger_types = {'bulletin_board': 'BulletinBoardDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.BulletinBoardPatternParameter(pattern=None, raw_pattern=None)

Bases: object

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

BulletinBoardPatternParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(pattern=None, raw_pattern=None)

BulletinBoardPatternParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'pattern': 'pattern', 'raw_pattern': 'rawPattern'}

property pattern

Gets the pattern of this BulletinBoardPatternParameter.

Returns:

The pattern of this BulletinBoardPatternParameter.

Return type:

object

property raw_pattern

Gets the raw_pattern of this BulletinBoardPatternParameter.

Returns:

The raw_pattern of this BulletinBoardPatternParameter.

Return type:

str

swagger_types = {'pattern': 'object', 'raw_pattern': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BulletinDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(category=None, group_id=None, id=None, level=None, message=None, node_address=None, source_id=None, source_name=None, source_type=None, timestamp=None)

BulletinDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property category

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

Returns:

The category of this BulletinDTO.

Return type:

str

property 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

property id

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

Returns:

The id of this BulletinDTO.

Return type:

int

property level

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

Returns:

The level of this BulletinDTO.

Return type:

str

property message

Gets the message of this BulletinDTO. The bulletin message.

Returns:

The message of this BulletinDTO.

Return type:

str

property 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

property 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

property 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

property source_type

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

Returns:

The source_type 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', 'source_type': 'str', 'timestamp': 'str'}

property timestamp

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

Returns:

The timestamp of this BulletinDTO.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BulletinEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletin=None, can_read=None, group_id=None, id=None, node_address=None, source_id=None, timestamp=None)

BulletinEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletin

Gets the bulletin of this BulletinEntity.

Returns:

The bulletin of this BulletinEntity.

Return type:

BulletinDTO

property 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

property group_id

Gets the group_id of this BulletinEntity.

Returns:

The group_id of this BulletinEntity.

Return type:

str

property id

Gets the id of this BulletinEntity.

Returns:

The id of this BulletinEntity.

Return type:

int

property node_address

Gets the node_address of this BulletinEntity.

Returns:

The node_address of this BulletinEntity.

Return type:

str

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

property timestamp

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

Returns:

The timestamp of this BulletinEntity.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

Bundle - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact=None, group=None, version=None)

Bundle - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property group

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

Returns:

The group of this Bundle.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

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

Returns:

The version of this Bundle.

Return type:

str

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

Bases: object

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

BundleDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact=None, group=None, version=None)

BundleDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property group

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

Returns:

The group of this BundleDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

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

Returns:

The version of this BundleDTO.

Return type:

str

class nipyapi.nifi.models.ClientIdParameter(client_id=None)

Bases: object

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

ClientIdParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(client_id=None)

ClientIdParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'client_id': 'clientId'}

property client_id

Gets the client_id of this ClientIdParameter.

Returns:

The client_id of this ClientIdParameter.

Return type:

str

swagger_types = {'client_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ClusterDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(generated=None, nodes=None)

ClusterDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property generated

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

Returns:

The generated of this ClusterDTO.

Return type:

str

property nodes

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

Returns:

The nodes of this ClusterDTO.

Return type:

list[NodeDTO]

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ClusterEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cluster=None)

ClusterEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cluster': 'cluster'}

property cluster

Gets the cluster of this ClusterEntity.

Returns:

The cluster of this ClusterEntity.

Return type:

ClusterDTO

swagger_types = {'cluster': 'ClusterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ClusterSearchResultsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(node_results=None)

ClusterSearchResultsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'node_results': 'nodeResults'}

property node_results

Gets the node_results of this ClusterSearchResultsEntity.

Returns:

The node_results of this ClusterSearchResultsEntity.

Return type:

list[NodeSearchResultDTO]

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ClusterSummaryDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(clustered=None, connected_node_count=None, connected_nodes=None, connected_to_cluster=None, total_node_count=None)

ClusterSummaryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property clustered

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

Returns:

The clustered of this ClusterSummaryDTO.

Return type:

bool

property 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

property 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

property connected_to_cluster

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

Returns:

The connected_to_cluster of this ClusterSummaryDTO.

Return type:

bool

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ClusterSummaryEntity(cluster_summary=None)

Bases: object

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

ClusterSummaryEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cluster_summary=None)

ClusterSummaryEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cluster_summary': 'clusterSummary'}

property cluster_summary

Gets the cluster_summary of this ClusterSummaryEntity.

Returns:

The cluster_summary of this ClusterSummaryEntity.

Return type:

ClusterSummaryDTO

swagger_types = {'cluster_summary': 'ClusterSummaryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ComponentDetailsDTO

Bases: object

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

ComponentDetailsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__()

ComponentDetailsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ComponentDifferenceDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_id=None, component_name=None, component_type=None, differences=None, process_group_id=None)

ComponentDifferenceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component_id

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

Returns:

The component_id of this ComponentDifferenceDTO.

Return type:

str

property component_name

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

Returns:

The component_name of this ComponentDifferenceDTO.

Return type:

str

property component_type

Gets the component_type of this ComponentDifferenceDTO. The type of component

Returns:

The component_type of this ComponentDifferenceDTO.

Return type:

str

property 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]

property process_group_id

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

Returns:

The process_group_id of this ComponentDifferenceDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ComponentHistoryDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_id=None, property_history=None)

ComponentHistoryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component_id

Gets the component_id of this ComponentHistoryDTO. The component id.

Returns:

The component_id of this ComponentHistoryDTO.

Return type:

str

property property_history

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

Returns:

The property_history of this ComponentHistoryDTO.

Return type:

dict(str, PropertyHistoryDTO)

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ComponentHistoryEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_history=None)

ComponentHistoryEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component_history': 'componentHistory'}

property component_history

Gets the component_history of this ComponentHistoryEntity.

Returns:

The component_history of this ComponentHistoryEntity.

Return type:

ComponentHistoryDTO

swagger_types = {'component_history': 'ComponentHistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ComponentManifest(apis=None, controller_services=None, flow_analysis_rules=None, parameter_providers=None, processors=None, reporting_tasks=None)

Bases: object

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

ComponentManifest - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(apis=None, controller_services=None, flow_analysis_rules=None, parameter_providers=None, processors=None, reporting_tasks=None)

ComponentManifest - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property apis

Gets the apis of this ComponentManifest. Public interfaces defined in this bundle

Returns:

The apis of this ComponentManifest.

Return type:

list[DefinedType]

attribute_map = {'apis': 'apis', 'controller_services': 'controllerServices', 'flow_analysis_rules': 'flowAnalysisRules', 'parameter_providers': 'parameterProviders', 'processors': 'processors', 'reporting_tasks': 'reportingTasks'}

property controller_services

Gets the controller_services of this ComponentManifest. Controller Services provided in this bundle

Returns:

The controller_services of this ComponentManifest.

Return type:

list[ControllerServiceDefinition]

property flow_analysis_rules

Gets the flow_analysis_rules of this ComponentManifest. Flow Analysis Rules provided in this bundle

Returns:

The flow_analysis_rules of this ComponentManifest.

Return type:

list[FlowAnalysisRuleDefinition]

property parameter_providers

Gets the parameter_providers of this ComponentManifest. Parameter Providers provided in this bundle

Returns:

The parameter_providers of this ComponentManifest.

Return type:

list[ParameterProviderDefinition]

property processors

Gets the processors of this ComponentManifest. Processors provided in this bundle

Returns:

The processors of this ComponentManifest.

Return type:

list[ProcessorDefinition]

property reporting_tasks

Gets the reporting_tasks of this ComponentManifest. Reporting Tasks provided in this bundle

Returns:

The reporting_tasks of this ComponentManifest.

Return type:

list[ReportingTaskDefinition]

swagger_types = {'apis': 'list[DefinedType]', 'controller_services': 'list[ControllerServiceDefinition]', 'flow_analysis_rules': 'list[FlowAnalysisRuleDefinition]', 'parameter_providers': 'list[ParameterProviderDefinition]', 'processors': 'list[ProcessorDefinition]', 'reporting_tasks': 'list[ReportingTaskDefinition]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ComponentReferenceDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None, parent_group_id=None, position=None, versioned_component_id=None)

ComponentReferenceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

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

Returns:

The id of this ComponentReferenceDTO.

Return type:

str

property name

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

Returns:

The name of this ComponentReferenceDTO.

Return type:

str

property 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

property position

Gets the position of this ComponentReferenceDTO.

Returns:

The position of this ComponentReferenceDTO.

Return type:

PositionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

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

Bases: object

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

ComponentReferenceEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, parent_group_id=None, permissions=None, position=None, revision=None, uri=None)

ComponentReferenceEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ComponentReferenceEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ComponentReferenceEntity.

Returns:

The component of this ComponentReferenceEntity.

Return type:

ComponentReferenceDTO

property 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

property id

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

Returns:

The id of this ComponentReferenceEntity.

Return type:

str

property 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

property permissions

Gets the permissions of this ComponentReferenceEntity.

Returns:

The permissions of this ComponentReferenceEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ComponentReferenceEntity.

Returns:

The position of this ComponentReferenceEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ComponentReferenceEntity.

Returns:

The revision of this ComponentReferenceEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ComponentReferenceEntity.

Return type:

str

class nipyapi.nifi.models.ComponentRestrictionPermissionDTO(permissions=None, required_permission=None)

Bases: object

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

ComponentRestrictionPermissionDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(permissions=None, required_permission=None)

ComponentRestrictionPermissionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'permissions': 'permissions', 'required_permission': 'requiredPermission'}

property permissions

Gets the permissions of this ComponentRestrictionPermissionDTO.

Returns:

The permissions of this ComponentRestrictionPermissionDTO.

Return type:

PermissionsDTO

property required_permission

Gets the required_permission of this ComponentRestrictionPermissionDTO.

Returns:

The required_permission of this ComponentRestrictionPermissionDTO.

Return type:

RequiredPermissionDTO

swagger_types = {'permissions': 'PermissionsDTO', 'required_permission': 'RequiredPermissionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ComponentSearchResultDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(group_id=None, id=None, matches=None, name=None, parent_group=None, versioned_group=None)

ComponentSearchResultDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property matches

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

Returns:

The matches of this ComponentSearchResultDTO.

Return type:

list[str]

property 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

property parent_group

Gets the parent_group of this ComponentSearchResultDTO.

Returns:

The parent_group of this ComponentSearchResultDTO.

Return type:

SearchResultGroupDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_group

Gets the versioned_group of this ComponentSearchResultDTO.

Returns:

The versioned_group of this ComponentSearchResultDTO.

Return type:

SearchResultGroupDTO

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

Bases: object

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

ComponentStateDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cluster_state=None, component_id=None, drop_state_key_supported=None, local_state=None, state_description=None)

ComponentStateDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property cluster_state

Gets the cluster_state of this ComponentStateDTO.

Returns:

The cluster_state of this ComponentStateDTO.

Return type:

StateMapDTO

property component_id

Gets the component_id of this ComponentStateDTO. The component identifier.

Returns:

The component_id of this ComponentStateDTO.

Return type:

str

property drop_state_key_supported

Gets the drop_state_key_supported of this ComponentStateDTO. Whether dropping state by key is supported for this component. Defaults to false when not specified by the component.

Returns:

The drop_state_key_supported of this ComponentStateDTO.

Return type:

bool

property local_state

Gets the local_state of this ComponentStateDTO.

Returns:

The local_state of this ComponentStateDTO.

Return type:

StateMapDTO

property 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', 'drop_state_key_supported': 'bool', 'local_state': 'StateMapDTO', 'state_description': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ComponentStateEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_state=None)

ComponentStateEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component_state': 'componentState'}

property component_state

Gets the component_state of this ComponentStateEntity.

Returns:

The component_state of this ComponentStateEntity.

Return type:

ComponentStateDTO

swagger_types = {'component_state': 'ComponentStateDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ComponentValidationResultDTO(active_thread_count=None, currently_valid=None, id=None, name=None, process_group_id=None, reference_type=None, resultant_validation_errors=None, results_valid=None, state=None, validation_errors=None)

Bases: object

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

ComponentValidationResultDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, currently_valid=None, id=None, name=None, process_group_id=None, reference_type=None, resultant_validation_errors=None, results_valid=None, state=None, validation_errors=None)

ComponentValidationResultDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property active_thread_count

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

Returns:

The active_thread_count of this ComponentValidationResultDTO.

Return type:

int

attribute_map = {'active_thread_count': 'activeThreadCount', 'currently_valid': 'currentlyValid', 'id': 'id', 'name': 'name', 'process_group_id': 'processGroupId', 'reference_type': 'referenceType', 'resultant_validation_errors': 'resultantValidationErrors', 'results_valid': 'resultsValid', 'state': 'state', 'validation_errors': 'validationErrors'}

property currently_valid

Gets the currently_valid of this ComponentValidationResultDTO. Whether or not the component is currently valid

Returns:

The currently_valid of this ComponentValidationResultDTO.

Return type:

bool

property id

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

Returns:

The id of this ComponentValidationResultDTO.

Return type:

str

property name

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

Returns:

The name of this ComponentValidationResultDTO.

Return type:

str

property process_group_id

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

Returns:

The process_group_id of this ComponentValidationResultDTO.

Return type:

str

property reference_type

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

Returns:

The reference_type of this ComponentValidationResultDTO.

Return type:

str

property resultant_validation_errors

Gets the resultant_validation_errors of this ComponentValidationResultDTO. The validation errors that will apply to the component if the Parameter Context is changed

Returns:

The resultant_validation_errors of this ComponentValidationResultDTO.

Return type:

list[str]

property results_valid

Gets the results_valid of this ComponentValidationResultDTO. Whether or not the component will be valid if the Parameter Context is changed

Returns:

The results_valid of this ComponentValidationResultDTO.

Return type:

bool

property state

Gets the state of this ComponentValidationResultDTO. 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 ComponentValidationResultDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property validation_errors

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

Returns:

The validation_errors of this ComponentValidationResultDTO.

Return type:

list[str]

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

Bases: object

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

ComponentValidationResultEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

ComponentValidationResultEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ComponentValidationResultEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ComponentValidationResultEntity.

Returns:

The component of this ComponentValidationResultEntity.

Return type:

ComponentValidationResultDTO

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ComponentValidationResultEntity.

Return type:

bool

property id

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

Returns:

The id of this ComponentValidationResultEntity.

Return type:

str

property permissions

Gets the permissions of this ComponentValidationResultEntity.

Returns:

The permissions of this ComponentValidationResultEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ComponentValidationResultEntity.

Returns:

The position of this ComponentValidationResultEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ComponentValidationResultEntity.

Returns:

The revision of this ComponentValidationResultEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ComponentValidationResultEntity.

Return type:

str

class nipyapi.nifi.models.ComponentValidationResultsEntity(validation_results=None)

Bases: object

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

ComponentValidationResultsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(validation_results=None)

ComponentValidationResultsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'validation_results': 'validationResults'}

swagger_types = {'validation_results': 'list[ComponentValidationResultEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property validation_results

Gets the validation_results of this ComponentValidationResultsEntity. A List of ComponentValidationResultEntity, one for each component that is validated

Returns:

The validation_results of this ComponentValidationResultsEntity.

Return type:

list[ComponentValidationResultEntity]

class nipyapi.nifi.models.ConfigVerificationResultDTO(explanation=None, outcome=None, verification_step_name=None)

Bases: object

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

ConfigVerificationResultDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(explanation=None, outcome=None, verification_step_name=None)

ConfigVerificationResultDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'explanation': 'explanation', 'outcome': 'outcome', 'verification_step_name': 'verificationStepName'}

property explanation

Gets the explanation of this ConfigVerificationResultDTO. An explanation of why the step was or was not successful

Returns:

The explanation of this ConfigVerificationResultDTO.

Return type:

str

property outcome

Gets the outcome of this ConfigVerificationResultDTO. The outcome of the verification

Returns:

The outcome of this ConfigVerificationResultDTO.

Return type:

str

swagger_types = {'explanation': 'str', 'outcome': 'str', 'verification_step_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property verification_step_name

Gets the verification_step_name of this ConfigVerificationResultDTO. The name of the verification step

Returns:

The verification_step_name of this ConfigVerificationResultDTO.

Return type:

str

class nipyapi.nifi.models.ConfigurationAnalysisDTO(component_id=None, properties=None, referenced_attributes=None, supports_verification=None)

Bases: object

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

ConfigurationAnalysisDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_id=None, properties=None, referenced_attributes=None, supports_verification=None)

ConfigurationAnalysisDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component_id': 'componentId', 'properties': 'properties', 'referenced_attributes': 'referencedAttributes', 'supports_verification': 'supportsVerification'}

property component_id

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

Returns:

The component_id of this ConfigurationAnalysisDTO.

Return type:

str

property properties

Gets the properties of this ConfigurationAnalysisDTO. The configured properties for the component

Returns:

The properties of this ConfigurationAnalysisDTO.

Return type:

dict(str, str)

property referenced_attributes

Gets the referenced_attributes of this ConfigurationAnalysisDTO. The attributes that are referenced by the properties, mapped to recently used values

Returns:

The referenced_attributes of this ConfigurationAnalysisDTO.

Return type:

dict(str, str)

property supports_verification

Gets the supports_verification of this ConfigurationAnalysisDTO. Whether or not the component supports verification

Returns:

The supports_verification of this ConfigurationAnalysisDTO.

Return type:

bool

swagger_types = {'component_id': 'str', 'properties': 'dict(str, str)', 'referenced_attributes': 'dict(str, str)', 'supports_verification': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ConfigurationAnalysisEntity(configuration_analysis=None)

Bases: object

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

ConfigurationAnalysisEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(configuration_analysis=None)

ConfigurationAnalysisEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'configuration_analysis': 'configurationAnalysis'}

property configuration_analysis

Gets the configuration_analysis of this ConfigurationAnalysisEntity.

Returns:

The configuration_analysis of this ConfigurationAnalysisEntity.

Return type:

ConfigurationAnalysisDTO

swagger_types = {'configuration_analysis': 'ConfigurationAnalysisDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ConnectableComponent - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, group_id=None, id=None, instance_identifier=None, name=None, type=None)

ConnectableComponent - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property comments

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

Returns:

The comments of this ConnectableComponent.

Return type:

str

property 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

property id

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

Returns:

The id of this ConnectableComponent.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this ConnectableComponent.

Return type:

str

property name

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

Returns:

The name of this ConnectableComponent.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this ConnectableComponent.

Return type:

str

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

Bases: object

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

ConnectableDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, exists=None, group_id=None, id=None, name=None, running=None, transmitting=None, type=None, versioned_component_id=None)

ConnectableDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property comments

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

Returns:

The comments of this ConnectableDTO.

Return type:

str

property 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

property 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

property id

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

Returns:

The id of this ConnectableDTO.

Return type:

str

property name

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

Returns:

The name of this ConnectableDTO.

Return type:

str

property running

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

Returns:

The running of this ConnectableDTO.

Return type:

bool

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property type

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

Returns:

The type of this ConnectableDTO.

Return type:

str

property 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

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

Bases: object

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

ConnectionDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(available_relationships=None, back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, destination=None, flow_file_expiration=None, getz_index=None, id=None, label_index=None, load_balance_compression=None, load_balance_partition_attribute=None, load_balance_status=None, load_balance_strategy=None, name=None, parent_group_id=None, position=None, prioritizers=None, retried_relationships=None, selected_relationships=None, source=None, versioned_component_id=None)

ConnectionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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', 'retried_relationships': 'retriedRelationships', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'versioned_component_id': 'versionedComponentId'}

property 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]

property 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

property 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

property bends

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

Returns:

The bends of this ConnectionDTO.

Return type:

list[PositionDTO]

property destination

Gets the destination of this ConnectionDTO.

Returns:

The destination of this ConnectionDTO.

Return type:

ConnectableDTO

property 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

property 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

property id

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

Returns:

The id of this ConnectionDTO.

Return type:

str

property 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

property 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. Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details.

Returns:

The load_balance_compression of this ConnectionDTO.

Return type:

str

property 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

property 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. Possible returned values: LOAD_BALANCE_NOT_CONFIGURED, LOAD_BALANCE_INACTIVE, LOAD_BALANCE_ACTIVE. See LoadBalanceStatus.class for more details.

Returns:

The load_balance_status of this ConnectionDTO.

Return type:

str

property 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. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details.

Returns:

The load_balance_strategy of this ConnectionDTO.

Return type:

str

property name

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

Returns:

The name of this ConnectionDTO.

Return type:

str

property 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

property position

Gets the position of this ConnectionDTO.

Returns:

The position of this ConnectionDTO.

Return type:

PositionDTO

property prioritizers

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

Returns:

The prioritizers of this ConnectionDTO.

Return type:

list[str]

property retried_relationships

Gets the retried_relationships of this ConnectionDTO. The relationships from the source of the connection that are configured to be retried.

Returns:

The retried_relationships of this ConnectionDTO.

Return type:

list[str]

property 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]

property source

Gets the source of this ConnectionDTO.

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]', 'retried_relationships': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableDTO', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

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

Bases: object

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

ConnectionEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bends=None, bulletins=None, component=None, destination_group_id=None, destination_id=None, destination_type=None, disconnected_node_acknowledged=None, getz_index=None, id=None, label_index=None, permissions=None, position=None, revision=None, source_group_id=None, source_id=None, source_type=None, status=None, uri=None)

ConnectionEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bends

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

Returns:

The bends of this ConnectionEntity.

Return type:

list[PositionDTO]

property bulletins

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

Returns:

The bulletins of this ConnectionEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ConnectionEntity.

Returns:

The component of this ConnectionEntity.

Return type:

ConnectionDTO

property 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

property 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

property 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

property 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

property 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

property id

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

Returns:

The id of this ConnectionEntity.

Return type:

str

property 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

property permissions

Gets the permissions of this ConnectionEntity.

Returns:

The permissions of this ConnectionEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ConnectionEntity.

Returns:

The position of this ConnectionEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ConnectionEntity.

Returns:

The revision of this ConnectionEntity.

Return type:

RevisionDTO

property 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

property 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

property 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

property status

Gets the status of this ConnectionEntity.

Returns:

The status of this ConnectionEntity.

Return type:

ConnectionStatusDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ConnectionEntity.

Return type:

str

class nipyapi.nifi.models.ConnectionStatisticsDTO(aggregate_snapshot=None, id=None, node_snapshots=None, stats_last_refreshed=None)

Bases: object

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

ConnectionStatisticsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, id=None, node_snapshots=None, stats_last_refreshed=None)

ConnectionStatisticsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this ConnectionStatisticsDTO.

Returns:

The aggregate_snapshot of this ConnectionStatisticsDTO.

Return type:

ConnectionStatisticsSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'id': 'id', 'node_snapshots': 'nodeSnapshots', 'stats_last_refreshed': 'statsLastRefreshed'}

property id

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

Returns:

The id of this ConnectionStatisticsDTO.

Return type:

str

property node_snapshots

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

Returns:

The node_snapshots of this ConnectionStatisticsDTO.

Return type:

list[NodeConnectionStatisticsSnapshotDTO]

property stats_last_refreshed

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

Returns:

The stats_last_refreshed of this ConnectionStatisticsDTO.

Return type:

str

swagger_types = {'aggregate_snapshot': 'ConnectionStatisticsSnapshotDTO', 'id': 'str', 'node_snapshots': 'list[NodeConnectionStatisticsSnapshotDTO]', 'stats_last_refreshed': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ConnectionStatisticsEntity(can_read=None, connection_statistics=None)

Bases: object

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

ConnectionStatisticsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, connection_statistics=None)

ConnectionStatisticsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'connection_statistics': 'connectionStatistics'}

property can_read

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

Returns:

The can_read of this ConnectionStatisticsEntity.

Return type:

bool

property connection_statistics

Gets the connection_statistics of this ConnectionStatisticsEntity.

Returns:

The connection_statistics of this ConnectionStatisticsEntity.

Return type:

ConnectionStatisticsDTO

swagger_types = {'can_read': 'bool', 'connection_statistics': 'ConnectionStatisticsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ConnectionStatisticsSnapshotDTO(id=None, predicted_bytes_at_next_interval=None, predicted_count_at_next_interval=None, predicted_millis_until_bytes_backpressure=None, predicted_millis_until_count_backpressure=None, predicted_percent_bytes=None, predicted_percent_count=None, prediction_interval_millis=None)

Bases: object

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

ConnectionStatisticsSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, predicted_bytes_at_next_interval=None, predicted_count_at_next_interval=None, predicted_millis_until_bytes_backpressure=None, predicted_millis_until_count_backpressure=None, predicted_percent_bytes=None, predicted_percent_count=None, prediction_interval_millis=None)

ConnectionStatisticsSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', 'predicted_percent_bytes': 'predictedPercentBytes', 'predicted_percent_count': 'predictedPercentCount', 'prediction_interval_millis': 'predictionIntervalMillis'}

property id

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

Returns:

The id of this ConnectionStatisticsSnapshotDTO.

Return type:

str

property predicted_bytes_at_next_interval

Gets the predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO. The predicted total number of bytes in the queue at the next configured interval.

Returns:

The predicted_bytes_at_next_interval of this ConnectionStatisticsSnapshotDTO.

Return type:

int

property predicted_count_at_next_interval

Gets the predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO. The predicted number of queued objects at the next configured interval.

Returns:

The predicted_count_at_next_interval of this ConnectionStatisticsSnapshotDTO.

Return type:

int

property predicted_millis_until_bytes_backpressure

Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO. The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue.

Returns:

The predicted_millis_until_bytes_backpressure of this ConnectionStatisticsSnapshotDTO.

Return type:

int

property predicted_millis_until_count_backpressure

Gets the predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO. The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count.

Returns:

The predicted_millis_until_count_backpressure of this ConnectionStatisticsSnapshotDTO.

Return type:

int

property predicted_percent_bytes

Gets the predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO. The predicted percentage of bytes in the queue against current threshold at the next configured interval.

Returns:

The predicted_percent_bytes of this ConnectionStatisticsSnapshotDTO.

Return type:

int

property predicted_percent_count

Gets the predicted_percent_count of this ConnectionStatisticsSnapshotDTO. The predicted percentage of queued objects at the next configured interval.

Returns:

The predicted_percent_count of this ConnectionStatisticsSnapshotDTO.

Return type:

int

property prediction_interval_millis

Gets the prediction_interval_millis of this ConnectionStatisticsSnapshotDTO. The prediction interval in seconds

Returns:

The prediction_interval_millis of this ConnectionStatisticsSnapshotDTO.

Return type:

int

swagger_types = {'id': 'str', 'predicted_bytes_at_next_interval': 'int', 'predicted_count_at_next_interval': 'int', 'predicted_millis_until_bytes_backpressure': 'int', 'predicted_millis_until_count_backpressure': 'int', 'predicted_percent_bytes': 'int', 'predicted_percent_count': 'int', 'prediction_interval_millis': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ConnectionStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, destination_id=None, destination_name=None, group_id=None, id=None, name=None, node_snapshots=None, source_id=None, source_name=None, stats_last_refreshed=None)

ConnectionStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this ConnectionStatusDTO.

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

property 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

property 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

property 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

property id

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

Returns:

The id of this ConnectionStatusDTO.

Return type:

str

property name

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

Returns:

The name of this ConnectionStatusDTO.

Return type:

str

property 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]

property 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

property 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

property stats_last_refreshed

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

Returns:

The stats_last_refreshed of this ConnectionStatusDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ConnectionStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, connection_status=None)

ConnectionStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property connection_status

Gets the connection_status of this ConnectionStatusEntity.

Returns:

The connection_status of this ConnectionStatusEntity.

Return type:

ConnectionStatusDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ConnectionStatusPredictionsSnapshotDTO(predicted_bytes_at_next_interval=None, predicted_count_at_next_interval=None, predicted_millis_until_bytes_backpressure=None, predicted_millis_until_count_backpressure=None, predicted_percent_bytes=None, predicted_percent_count=None, prediction_interval_seconds=None)

Bases: object

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

ConnectionStatusPredictionsSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(predicted_bytes_at_next_interval=None, predicted_count_at_next_interval=None, predicted_millis_until_bytes_backpressure=None, predicted_millis_until_count_backpressure=None, predicted_percent_bytes=None, predicted_percent_count=None, prediction_interval_seconds=None)

ConnectionStatusPredictionsSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'predicted_bytes_at_next_interval': 'predictedBytesAtNextInterval', 'predicted_count_at_next_interval': 'predictedCountAtNextInterval', 'predicted_millis_until_bytes_backpressure': 'predictedMillisUntilBytesBackpressure', 'predicted_millis_until_count_backpressure': 'predictedMillisUntilCountBackpressure', 'predicted_percent_bytes': 'predictedPercentBytes', 'predicted_percent_count': 'predictedPercentCount', 'prediction_interval_seconds': 'predictionIntervalSeconds'}

property predicted_bytes_at_next_interval

Gets the predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. The predicted total number of bytes in the queue at the next configured interval.

Returns:

The predicted_bytes_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

property predicted_count_at_next_interval

Gets the predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO. The predicted number of queued objects at the next configured interval.

Returns:

The predicted_count_at_next_interval of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

property predicted_millis_until_bytes_backpressure

Gets the predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO. The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue.

Returns:

The predicted_millis_until_bytes_backpressure of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

property predicted_millis_until_count_backpressure

Gets the predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO. The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count.

Returns:

The predicted_millis_until_count_backpressure of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

property predicted_percent_bytes

Gets the predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO. Predicted connection percent use regarding queued flow files size and backpressure threshold if configured.

Returns:

The predicted_percent_bytes of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

property predicted_percent_count

Gets the predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO. Predicted connection percent use regarding queued flow files count and backpressure threshold if configured.

Returns:

The predicted_percent_count of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

property prediction_interval_seconds

Gets the prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO. The configured interval (in seconds) for predicting connection queue count and size (and percent usage).

Returns:

The prediction_interval_seconds of this ConnectionStatusPredictionsSnapshotDTO.

Return type:

int

swagger_types = {'predicted_bytes_at_next_interval': 'int', 'predicted_count_at_next_interval': 'int', 'predicted_millis_until_bytes_backpressure': 'int', 'predicted_millis_until_count_backpressure': 'int', 'predicted_percent_bytes': 'int', 'predicted_percent_count': 'int', 'prediction_interval_seconds': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ConnectionStatusSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bytes_in=None, bytes_out=None, bytes_queued=None, destination_id=None, destination_name=None, flow_file_availability=None, flow_files_in=None, flow_files_out=None, flow_files_queued=None, group_id=None, id=None, input=None, load_balance_status=None, name=None, output=None, percent_use_bytes=None, percent_use_count=None, predictions=None, queued=None, queued_count=None, queued_size=None, source_id=None, source_name=None)

ConnectionStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bytes_in': 'bytesIn', 'bytes_out': 'bytesOut', 'bytes_queued': 'bytesQueued', 'destination_id': 'destinationId', 'destination_name': 'destinationName', 'flow_file_availability': 'flowFileAvailability', 'flow_files_in': 'flowFilesIn', 'flow_files_out': 'flowFilesOut', 'flow_files_queued': 'flowFilesQueued', 'group_id': 'groupId', 'id': 'id', 'input': 'input', 'load_balance_status': 'loadBalanceStatus', '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'}

property 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

property 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

property 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

property 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

property 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

property flow_file_availability

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

Returns:

The flow_file_availability of this ConnectionStatusSnapshotDTO.

Return type:

str

property 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

property 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

property 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

property 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

property id

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

Returns:

The id of this ConnectionStatusSnapshotDTO.

Return type:

str

property 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

property load_balance_status

Gets the load_balance_status of this ConnectionStatusSnapshotDTO. The load balance status of the connection

Returns:

The load_balance_status of this ConnectionStatusSnapshotDTO.

Return type:

str

property name

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

Returns:

The name of this ConnectionStatusSnapshotDTO.

Return type:

str

property output

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

Returns:

The output of this ConnectionStatusSnapshotDTO.

Return type:

str

property 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

property 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

property predictions

Gets the predictions of this ConnectionStatusSnapshotDTO.

Returns:

The predictions of this ConnectionStatusSnapshotDTO.

Return type:

ConnectionStatusPredictionsSnapshotDTO

property 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

property 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

property 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

property 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

property source_name

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

Returns:

The source_name of this ConnectionStatusSnapshotDTO.

Return type:

str

swagger_types = {'bytes_in': 'int', 'bytes_out': 'int', 'bytes_queued': 'int', 'destination_id': 'str', 'destination_name': 'str', 'flow_file_availability': 'str', 'flow_files_in': 'int', 'flow_files_out': 'int', 'flow_files_queued': 'int', 'group_id': 'str', 'id': 'str', 'input': 'str', 'load_balance_status': 'str', 'name': 'str', 'output': 'str', 'percent_use_bytes': 'int', 'percent_use_count': 'int', 'predictions': 'ConnectionStatusPredictionsSnapshotDTO', 'queued': 'str', 'queued_count': 'str', 'queued_size': 'str', 'source_id': 'str', 'source_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ConnectionStatusSnapshotEntity(can_read=None, connection_status_snapshot=None, id=None)

Bases: object

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

ConnectionStatusSnapshotEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, connection_status_snapshot=None, id=None)

ConnectionStatusSnapshotEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'connection_status_snapshot': 'connectionStatusSnapshot', 'id': 'id'}

property 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

property connection_status_snapshot

Gets the connection_status_snapshot of this ConnectionStatusSnapshotEntity.

Returns:

The connection_status_snapshot of this ConnectionStatusSnapshotEntity.

Return type:

ConnectionStatusSnapshotDTO

property id

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

Returns:

The id of this ConnectionStatusSnapshotEntity.

Return type:

str

swagger_types = {'can_read': 'bool', 'connection_status_snapshot': 'ConnectionStatusSnapshotDTO', 'id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ConnectionsEntity(connections=None)

Bases: object

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

ConnectionsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(connections=None)

ConnectionsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'connections': 'connections'}

property connections

Gets the connections of this ConnectionsEntity.

Returns:

The connections of this ConnectionsEntity.

Return type:

list[ConnectionEntity]

swagger_types = {'connections': 'list[ConnectionEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ContentViewerDTO(display_name=None, supported_mime_types=None, uri=None)

Bases: object

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

ContentViewerDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(display_name=None, supported_mime_types=None, uri=None)

ContentViewerDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'display_name': 'displayName', 'supported_mime_types': 'supportedMimeTypes', 'uri': 'uri'}

property display_name

Gets the display_name of this ContentViewerDTO. The display name of the Content Viewer.

Returns:

The display_name of this ContentViewerDTO.

Return type:

str

property supported_mime_types

Gets the supported_mime_types of this ContentViewerDTO. The mime types this Content Viewer supports.

Returns:

The supported_mime_types of this ContentViewerDTO.

Return type:

list[SupportedMimeTypesDTO]

swagger_types = {'display_name': 'str', 'supported_mime_types': 'list[SupportedMimeTypesDTO]', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this ContentViewerDTO. The uri of the Content Viewer.

Returns:

The uri of this ContentViewerDTO.

Return type:

str

class nipyapi.nifi.models.ContentViewerEntity(content_viewers=None)

Bases: object

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

ContentViewerEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(content_viewers=None)

ContentViewerEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'content_viewers': 'contentViewers'}

property content_viewers

Gets the content_viewers of this ContentViewerEntity. The Content Viewers.

Returns:

The content_viewers of this ContentViewerEntity.

Return type:

list[ContentViewerDTO]

swagger_types = {'content_viewers': 'list[ContentViewerDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerBulletinsEntity(bulletins=None, controller_service_bulletins=None, flow_analysis_rule_bulletins=None, flow_registry_client_bulletins=None, parameter_provider_bulletins=None, reporting_task_bulletins=None)

Bases: object

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

ControllerBulletinsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, controller_service_bulletins=None, flow_analysis_rule_bulletins=None, flow_registry_client_bulletins=None, parameter_provider_bulletins=None, reporting_task_bulletins=None)

ControllerBulletinsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bulletins': 'bulletins', 'controller_service_bulletins': 'controllerServiceBulletins', 'flow_analysis_rule_bulletins': 'flowAnalysisRuleBulletins', 'flow_registry_client_bulletins': 'flowRegistryClientBulletins', 'parameter_provider_bulletins': 'parameterProviderBulletins', 'reporting_task_bulletins': 'reportingTaskBulletins'}

property 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]

property 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]

property flow_analysis_rule_bulletins

Gets the flow_analysis_rule_bulletins of this ControllerBulletinsEntity. Flow Analysis Rule bulletins to be reported to the user.

Returns:

The flow_analysis_rule_bulletins of this ControllerBulletinsEntity.

Return type:

list[BulletinEntity]

property flow_registry_client_bulletins

Gets the flow_registry_client_bulletins of this ControllerBulletinsEntity. Flow registry client bulletins to be reported to the user.

Returns:

The flow_registry_client_bulletins of this ControllerBulletinsEntity.

Return type:

list[BulletinEntity]

property parameter_provider_bulletins

Gets the parameter_provider_bulletins of this ControllerBulletinsEntity. Parameter provider bulletins to be reported to the user.

Returns:

The parameter_provider_bulletins of this ControllerBulletinsEntity.

Return type:

list[BulletinEntity]

property 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]', 'flow_analysis_rule_bulletins': 'list[BulletinEntity]', 'flow_registry_client_bulletins': 'list[BulletinEntity]', 'parameter_provider_bulletins': 'list[BulletinEntity]', 'reporting_task_bulletins': 'list[BulletinEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerConfigurationDTO(max_timer_driven_thread_count=None)

Bases: object

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

ControllerConfigurationDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(max_timer_driven_thread_count=None)

ControllerConfigurationDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'max_timer_driven_thread_count': 'maxTimerDrivenThreadCount'}

property 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_timer_driven_thread_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerConfigurationEntity(component=None, disconnected_node_acknowledged=None, permissions=None, revision=None)

Bases: object

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

ControllerConfigurationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component=None, disconnected_node_acknowledged=None, permissions=None, revision=None)

ControllerConfigurationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component': 'component', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'permissions': 'permissions', 'revision': 'revision'}

property component

Gets the component of this ControllerConfigurationEntity.

Returns:

The component of this ControllerConfigurationEntity.

Return type:

ControllerConfigurationDTO

property 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

property permissions

Gets the permissions of this ControllerConfigurationEntity.

Returns:

The permissions of this ControllerConfigurationEntity.

Return type:

PermissionsDTO

property revision

Gets the revision of this ControllerConfigurationEntity.

Returns:

The revision of this ControllerConfigurationEntity.

Return type:

RevisionDTO

swagger_types = {'component': 'ControllerConfigurationDTO', 'disconnected_node_acknowledged': 'bool', 'permissions': 'PermissionsDTO', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerDTO(active_remote_port_count=None, comments=None, disabled_count=None, id=None, inactive_remote_port_count=None, input_port_count=None, input_ports=None, instance_id=None, invalid_count=None, name=None, output_port_count=None, output_ports=None, remote_site_http_listening_port=None, remote_site_listening_port=None, running_count=None, site_to_site_secure=None, stopped_count=None)

Bases: object

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

ControllerDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_remote_port_count=None, comments=None, disabled_count=None, id=None, inactive_remote_port_count=None, input_port_count=None, input_ports=None, instance_id=None, invalid_count=None, name=None, output_port_count=None, output_ports=None, remote_site_http_listening_port=None, remote_site_listening_port=None, running_count=None, site_to_site_secure=None, stopped_count=None)

ControllerDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property comments

Gets the comments of this ControllerDTO. The comments for the NiFi.

Returns:

The comments of this ControllerDTO.

Return type:

str

property 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

property id

Gets the id of this ControllerDTO. The id of the NiFi.

Returns:

The id of this ControllerDTO.

Return type:

str

property 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

property 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

property 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]

property 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

property 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

property name

Gets the name of this ControllerDTO. The name of the NiFi.

Returns:

The name of this ControllerDTO.

Return type:

str

property 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

property 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]

property 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

property 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

property 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

property 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

property stopped_count

Gets the stopped_count of this ControllerDTO. The number of stopped components in the NiFi.

Returns:

The stopped_count of this ControllerDTO.

Return type:

int

swagger_types = {'active_remote_port_count': 'int', 'comments': 'str', 'disabled_count': 'int', 'id': 'str', 'inactive_remote_port_count': 'int', 'input_port_count': 'int', 'input_ports': 'list[PortDTO]', 'instance_id': 'str', 'invalid_count': 'int', 'name': 'str', 'output_port_count': 'int', 'output_ports': 'list[PortDTO]', 'remote_site_http_listening_port': 'int', 'remote_site_listening_port': 'int', 'running_count': 'int', 'site_to_site_secure': 'bool', 'stopped_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerEntity(controller=None)

Bases: object

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

ControllerEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller=None)

ControllerEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller': 'controller'}

property controller

Gets the controller of this ControllerEntity.

Returns:

The controller of this ControllerEntity.

Return type:

ControllerDTO

swagger_types = {'controller': 'ControllerDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerServiceAPI(bundle=None, type=None)

Bases: object

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

ControllerServiceAPI - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, type=None)

ControllerServiceAPI - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bundle': 'bundle', 'type': 'type'}

property bundle

Gets the bundle of this ControllerServiceAPI.

Returns:

The bundle of this ControllerServiceAPI.

Return type:

Bundle

swagger_types = {'bundle': 'Bundle', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ControllerServiceAPI. The fully qualified name of the service interface.

Returns:

The type of this ControllerServiceAPI.

Return type:

str

class nipyapi.nifi.models.ControllerServiceApiDTO(bundle=None, type=None)

Bases: object

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

ControllerServiceApiDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, type=None)

ControllerServiceApiDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bundle': 'bundle', 'type': 'type'}

property bundle

Gets the bundle of this ControllerServiceApiDTO.

Returns:

The bundle of this ControllerServiceApiDTO.

Return type:

BundleDTO

swagger_types = {'bundle': 'BundleDTO', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ControllerServiceApiDTO. The fully qualified name of the service interface.

Returns:

The type of this ControllerServiceApiDTO.

Return type:

str

class nipyapi.nifi.models.ControllerServiceDTO(annotation_data=None, bulletin_level=None, bundle=None, comments=None, controller_service_apis=None, custom_ui_url=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, referencing_components=None, restricted=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

Bases: object

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

ControllerServiceDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, bulletin_level=None, bundle=None, comments=None, controller_service_apis=None, custom_ui_url=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, referencing_components=None, restricted=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

ControllerServiceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property annotation_data

Gets the annotation_data of this ControllerServiceDTO. The annotation for the controller service. This is how the custom UI relays configuration to the controller service.

Returns:

The annotation_data of this ControllerServiceDTO.

Return type:

str

attribute_map = {'annotation_data': 'annotationData', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'controller_service_apis': 'controllerServiceApis', 'custom_ui_url': 'customUiUrl', 'deprecated': 'deprecated', 'descriptors': 'descriptors', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'properties': 'properties', 'referencing_components': 'referencingComponents', 'restricted': 'restricted', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'state': 'state', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

property bulletin_level

Gets the bulletin_level of this ControllerServiceDTO. The level at which the controller service will report bulletins.

Returns:

The bulletin_level of this ControllerServiceDTO.

Return type:

str

property bundle

Gets the bundle of this ControllerServiceDTO.

Returns:

The bundle of this ControllerServiceDTO.

Return type:

BundleDTO

property comments

Gets the comments of this ControllerServiceDTO. The comments for the controller service.

Returns:

The comments of this ControllerServiceDTO.

Return type:

str

property 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]

property 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

property deprecated

Gets the deprecated of this ControllerServiceDTO. Whether the ontroller service has been deprecated.

Returns:

The deprecated of this ControllerServiceDTO.

Return type:

bool

property 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)

property 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

property id

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

Returns:

The id of this ControllerServiceDTO.

Return type:

str

property 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

property name

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

Returns:

The name of this ControllerServiceDTO.

Return type:

str

property 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

property 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

property position

Gets the position of this ControllerServiceDTO.

Returns:

The position of this ControllerServiceDTO.

Return type:

PositionDTO

property properties

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

Returns:

The properties of this ControllerServiceDTO.

Return type:

dict(str, str)

property 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]

property restricted

Gets the restricted of this ControllerServiceDTO. Whether the controller service requires elevated privileges.

Returns:

The restricted of this ControllerServiceDTO.

Return type:

bool

property sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ControllerServiceDTO. Set of sensitive dynamic property names

Returns:

The sensitive_dynamic_property_names of this ControllerServiceDTO.

Return type:

list[str]

property state

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

Returns:

The state of this ControllerServiceDTO.

Return type:

str

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ControllerServiceDTO. Whether the controller service supports sensitive dynamic properties.

Returns:

The supports_sensitive_dynamic_properties of this ControllerServiceDTO.

Return type:

bool

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'BundleDTO', 'comments': 'str', 'controller_service_apis': 'list[ControllerServiceApiDTO]', 'custom_ui_url': 'str', 'deprecated': 'bool', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'extension_missing': 'bool', 'id': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'properties': 'dict(str, str)', 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', 'restricted': 'bool', 'sensitive_dynamic_property_names': 'list[str]', 'state': 'str', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this ControllerServiceDTO.

Return type:

str

property 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]

property 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

property 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

class nipyapi.nifi.models.ControllerServiceDefinition(additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

Bases: object

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

ControllerServiceDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

ControllerServiceDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property additional_details

Gets the additional_details of this ControllerServiceDefinition. Indicates if the component has additional details documentation

Returns:

The additional_details of this ControllerServiceDefinition.

Return type:

bool

property artifact

Gets the artifact of this ControllerServiceDefinition. The artifact name of the bundle that provides the referenced type.

Returns:

The artifact of this ControllerServiceDefinition.

Return type:

str

attribute_map = {'additional_details': 'additionalDetails', 'artifact': 'artifact', 'build_info': 'buildInfo', 'deprecated': 'deprecated', 'deprecation_alternatives': 'deprecationAlternatives', 'deprecation_reason': 'deprecationReason', 'dynamic_properties': 'dynamicProperties', 'explicit_restrictions': 'explicitRestrictions', 'group': 'group', 'property_descriptors': 'propertyDescriptors', 'provided_api_implementations': 'providedApiImplementations', 'restricted': 'restricted', 'restricted_explanation': 'restrictedExplanation', 'see_also': 'seeAlso', 'stateful': 'stateful', 'supports_dynamic_properties': 'supportsDynamicProperties', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'system_resource_considerations': 'systemResourceConsiderations', 'tags': 'tags', 'type': 'type', 'type_description': 'typeDescription', 'version': 'version'}

property build_info

Gets the build_info of this ControllerServiceDefinition.

Returns:

The build_info of this ControllerServiceDefinition.

Return type:

BuildInfo

property deprecated

Gets the deprecated of this ControllerServiceDefinition. Whether or not the component has been deprecated

Returns:

The deprecated of this ControllerServiceDefinition.

Return type:

bool

property deprecation_alternatives

Gets the deprecation_alternatives of this ControllerServiceDefinition. If this component has been deprecated, this optional field provides alternatives to use

Returns:

The deprecation_alternatives of this ControllerServiceDefinition.

Return type:

list[str]

property deprecation_reason

Gets the deprecation_reason of this ControllerServiceDefinition. If this component has been deprecated, this optional field can be used to provide an explanation

Returns:

The deprecation_reason of this ControllerServiceDefinition.

Return type:

str

property dynamic_properties

Gets the dynamic_properties of this ControllerServiceDefinition. Describes the dynamic properties supported by this component

Returns:

The dynamic_properties of this ControllerServiceDefinition.

Return type:

list[DynamicProperty]

property explicit_restrictions

Gets the explicit_restrictions of this ControllerServiceDefinition. Explicit restrictions that indicate a require permission to use the component

Returns:

The explicit_restrictions of this ControllerServiceDefinition.

Return type:

list[Restriction]

property group

Gets the group of this ControllerServiceDefinition. The group name of the bundle that provides the referenced type.

Returns:

The group of this ControllerServiceDefinition.

Return type:

str

property property_descriptors

Gets the property_descriptors of this ControllerServiceDefinition. Descriptions of configuration properties applicable to this component.

Returns:

The property_descriptors of this ControllerServiceDefinition.

Return type:

dict(str, PropertyDescriptor)

property provided_api_implementations

Gets the provided_api_implementations of this ControllerServiceDefinition. If this type represents a provider for an interface, this lists the APIs it implements

Returns:

The provided_api_implementations of this ControllerServiceDefinition.

Return type:

list[DefinedType]

property restricted

Gets the restricted of this ControllerServiceDefinition. Whether or not the component has a general restriction

Returns:

The restricted of this ControllerServiceDefinition.

Return type:

bool

property restricted_explanation

Gets the restricted_explanation of this ControllerServiceDefinition. An optional description of the general restriction

Returns:

The restricted_explanation of this ControllerServiceDefinition.

Return type:

str

property see_also

Gets the see_also of this ControllerServiceDefinition. The names of other component types that may be related

Returns:

The see_also of this ControllerServiceDefinition.

Return type:

list[str]

property stateful

Gets the stateful of this ControllerServiceDefinition.

Returns:

The stateful of this ControllerServiceDefinition.

Return type:

Stateful

property supports_dynamic_properties

Gets the supports_dynamic_properties of this ControllerServiceDefinition. Whether or not this component makes use of dynamic (user-set) properties.

Returns:

The supports_dynamic_properties of this ControllerServiceDefinition.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ControllerServiceDefinition. Whether or not this component makes use of sensitive dynamic (user-set) properties.

Returns:

The supports_sensitive_dynamic_properties of this ControllerServiceDefinition.

Return type:

bool

swagger_types = {'additional_details': 'bool', 'artifact': 'str', 'build_info': 'BuildInfo', 'deprecated': 'bool', 'deprecation_alternatives': 'list[str]', 'deprecation_reason': 'str', 'dynamic_properties': 'list[DynamicProperty]', 'explicit_restrictions': 'list[Restriction]', 'group': 'str', 'property_descriptors': 'dict(str, PropertyDescriptor)', 'provided_api_implementations': 'list[DefinedType]', 'restricted': 'bool', 'restricted_explanation': 'str', 'see_also': 'list[str]', 'stateful': 'Stateful', 'supports_dynamic_properties': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'system_resource_considerations': 'list[SystemResourceConsideration]', 'tags': 'list[str]', 'type': 'str', 'type_description': 'str', 'version': 'str'}

property system_resource_considerations

Gets the system_resource_considerations of this ControllerServiceDefinition. The system resource considerations for the given component

Returns:

The system_resource_considerations of this ControllerServiceDefinition.

Return type:

list[SystemResourceConsideration]

property tags

Gets the tags of this ControllerServiceDefinition. The tags associated with this type

Returns:

The tags of this ControllerServiceDefinition.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ControllerServiceDefinition. The fully-qualified class type

Returns:

The type of this ControllerServiceDefinition.

Return type:

str

property type_description

Gets the type_description of this ControllerServiceDefinition. The description of the type.

Returns:

The type_description of this ControllerServiceDefinition.

Return type:

str

property version

Gets the version of this ControllerServiceDefinition. The version of the bundle that provides the referenced type.

Returns:

The version of this ControllerServiceDefinition.

Return type:

str

class nipyapi.nifi.models.ControllerServiceEntity(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, parent_group_id=None, permissions=None, position=None, revision=None, status=None, uri=None)

Bases: object

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

ControllerServiceEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, parent_group_id=None, permissions=None, position=None, revision=None, status=None, uri=None)

ControllerServiceEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ControllerServiceEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ControllerServiceEntity.

Returns:

The component of this ControllerServiceEntity.

Return type:

ControllerServiceDTO

property 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

property id

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

Returns:

The id of this ControllerServiceEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this ControllerServiceEntity.

Returns:

The operate_permissions of this ControllerServiceEntity.

Return type:

PermissionsDTO

property 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

property permissions

Gets the permissions of this ControllerServiceEntity.

Returns:

The permissions of this ControllerServiceEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ControllerServiceEntity.

Returns:

The position of this ControllerServiceEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ControllerServiceEntity.

Returns:

The revision of this ControllerServiceEntity.

Return type:

RevisionDTO

property status

Gets the status of this ControllerServiceEntity.

Returns:

The status of this ControllerServiceEntity.

Return type:

ControllerServiceStatusDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ControllerServiceEntity.

Return type:

str

class nipyapi.nifi.models.ControllerServiceReferencingComponentDTO(active_thread_count=None, descriptors=None, group_id=None, id=None, name=None, properties=None, reference_cycle=None, reference_type=None, referencing_components=None, state=None, type=None, validation_errors=None)

Bases: object

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

ControllerServiceReferencingComponentDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, descriptors=None, group_id=None, id=None, name=None, properties=None, reference_cycle=None, reference_type=None, referencing_components=None, state=None, type=None, validation_errors=None)

ControllerServiceReferencingComponentDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property descriptors

Gets the descriptors of this ControllerServiceReferencingComponentDTO. The descriptors for the component properties.

Returns:

The descriptors of this ControllerServiceReferencingComponentDTO.

Return type:

dict(str, PropertyDescriptorDTO)

property 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

property 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

property 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

property properties

Gets the properties of this ControllerServiceReferencingComponentDTO. The properties for the component.

Returns:

The properties of this ControllerServiceReferencingComponentDTO.

Return type:

dict(str, str)

property 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

property 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

property 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]

property state

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

Returns:

The state of this ControllerServiceReferencingComponentDTO.

Return type:

str

swagger_types = {'active_thread_count': 'int', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'group_id': 'str', 'id': 'str', 'name': 'str', 'properties': 'dict(str, str)', 'reference_cycle': 'bool', 'reference_type': 'str', 'referencing_components': 'list[ControllerServiceReferencingComponentEntity]', 'state': 'str', 'type': 'str', 'validation_errors': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property 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]

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

Bases: object

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

ControllerServiceReferencingComponentEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, uri=None)

ControllerServiceReferencingComponentEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ControllerServiceReferencingComponentEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ControllerServiceReferencingComponentEntity.

Returns:

The component of this ControllerServiceReferencingComponentEntity.

Return type:

ControllerServiceReferencingComponentDTO

property 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

property id

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

Returns:

The id of this ControllerServiceReferencingComponentEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this ControllerServiceReferencingComponentEntity.

Returns:

The operate_permissions of this ControllerServiceReferencingComponentEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this ControllerServiceReferencingComponentEntity.

Returns:

The permissions of this ControllerServiceReferencingComponentEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ControllerServiceReferencingComponentEntity.

Returns:

The position of this ControllerServiceReferencingComponentEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ControllerServiceReferencingComponentEntity.

Returns:

The revision of this ControllerServiceReferencingComponentEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ControllerServiceReferencingComponentEntity.

Return type:

str

class nipyapi.nifi.models.ControllerServiceReferencingComponentsEntity(controller_service_referencing_components=None)

Bases: object

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

ControllerServiceReferencingComponentsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_service_referencing_components=None)

ControllerServiceReferencingComponentsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_service_referencing_components': 'controllerServiceReferencingComponents'}

property controller_service_referencing_components

Gets the controller_service_referencing_components of this ControllerServiceReferencingComponentsEntity.

Returns:

The controller_service_referencing_components of this ControllerServiceReferencingComponentsEntity.

Return type:

list[ControllerServiceReferencingComponentEntity]

swagger_types = {'controller_service_referencing_components': 'list[ControllerServiceReferencingComponentEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerServiceRunStatusEntity(disconnected_node_acknowledged=None, revision=None, state=None, ui_only=None)

Bases: object

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

ControllerServiceRunStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, revision=None, state=None, ui_only=None)

ControllerServiceRunStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision', 'state': 'state', 'ui_only': 'uiOnly'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ControllerServiceRunStatusEntity.

Return type:

bool

property revision

Gets the revision of this ControllerServiceRunStatusEntity.

Returns:

The revision of this ControllerServiceRunStatusEntity.

Return type:

RevisionDTO

property state

Gets the state of this ControllerServiceRunStatusEntity. The run status of the ControllerService.

Returns:

The state of this ControllerServiceRunStatusEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO', 'state': 'str', 'ui_only': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property ui_only

Gets the ui_only of this ControllerServiceRunStatusEntity. Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI.

Returns:

The ui_only of this ControllerServiceRunStatusEntity.

Return type:

bool

class nipyapi.nifi.models.ControllerServiceStatusDTO(active_thread_count=None, run_status=None, validation_status=None)

Bases: object

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

ControllerServiceStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, run_status=None, validation_status=None)

ControllerServiceStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property active_thread_count

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

Returns:

The active_thread_count of this ControllerServiceStatusDTO.

Return type:

int

attribute_map = {'active_thread_count': 'activeThreadCount', 'run_status': 'runStatus', 'validation_status': 'validationStatus'}

property run_status

Gets the run_status of this ControllerServiceStatusDTO. The run status of this ControllerService

Returns:

The run_status of this ControllerServiceStatusDTO.

Return type:

str

swagger_types = {'active_thread_count': 'int', 'run_status': 'str', 'validation_status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property validation_status

Gets the validation_status of this ControllerServiceStatusDTO. 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 ControllerServiceStatusDTO.

Return type:

str

class nipyapi.nifi.models.ControllerServiceTypesEntity(controller_service_types=None)

Bases: object

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

ControllerServiceTypesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_service_types=None)

ControllerServiceTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_service_types': 'controllerServiceTypes'}

property controller_service_types

Gets the controller_service_types of this ControllerServiceTypesEntity.

Returns:

The controller_service_types of this ControllerServiceTypesEntity.

Return type:

list[DocumentedTypeDTO]

swagger_types = {'controller_service_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerServicesEntity(controller_services=None, current_time=None)

Bases: object

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

ControllerServicesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_services=None, current_time=None)

ControllerServicesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_services': 'controllerServices', 'current_time': 'currentTime'}

property controller_services

Gets the controller_services of this ControllerServicesEntity.

Returns:

The controller_services of this ControllerServicesEntity.

Return type:

list[ControllerServiceEntity]

property current_time

Gets the current_time of this ControllerServicesEntity. The current time on the system.

Returns:

The current_time of this ControllerServicesEntity.

Return type:

str

swagger_types = {'controller_services': 'list[ControllerServiceEntity]', 'current_time': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ControllerStatusDTO(active_remote_port_count=None, active_thread_count=None, bytes_queued=None, disabled_count=None, flow_files_queued=None, inactive_remote_port_count=None, invalid_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, queued=None, running_count=None, stale_count=None, stopped_count=None, sync_failure_count=None, terminated_thread_count=None, up_to_date_count=None)

Bases: object

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

ControllerStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_remote_port_count=None, active_thread_count=None, bytes_queued=None, disabled_count=None, flow_files_queued=None, inactive_remote_port_count=None, invalid_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, queued=None, running_count=None, stale_count=None, stopped_count=None, sync_failure_count=None, terminated_thread_count=None, up_to_date_count=None)

ControllerStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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

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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property queued

Gets the queued of this ControllerStatusDTO. The number of flowfiles queued in the NiFi.

Returns:

The queued of this ControllerStatusDTO.

Return type:

str

property 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

property 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

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

property 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

property terminated_thread_count

Gets the terminated_thread_count of this ControllerStatusDTO. The number of terminated threads in the NiFi.

Returns:

The terminated_thread_count of this ControllerStatusDTO.

Return type:

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ControllerStatusEntity(controller_status=None)

Bases: object

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

ControllerStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_status=None)

ControllerStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_status': 'controllerStatus'}

property controller_status

Gets the controller_status of this ControllerStatusEntity.

Returns:

The controller_status of this ControllerStatusEntity.

Return type:

ControllerStatusDTO

swagger_types = {'controller_status': 'ControllerStatusDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CopyRequestEntity(connections=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None)

Bases: object

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

CopyRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(connections=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None)

CopyRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'connections': 'connections', 'funnels': 'funnels', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

property connections

Gets the connections of this CopyRequestEntity. The ids of the connections to be copied.

Returns:

The connections of this CopyRequestEntity.

Return type:

list[str]

property funnels

Gets the funnels of this CopyRequestEntity. The ids of the funnels to be copied.

Returns:

The funnels of this CopyRequestEntity.

Return type:

list[str]

property input_ports

Gets the input_ports of this CopyRequestEntity. The ids of the input ports to be copied.

Returns:

The input_ports of this CopyRequestEntity.

Return type:

list[str]

property labels

Gets the labels of this CopyRequestEntity. The ids of the labels to be copied.

Returns:

The labels of this CopyRequestEntity.

Return type:

list[str]

property output_ports

Gets the output_ports of this CopyRequestEntity. The ids of the output ports to be copied.

Returns:

The output_ports of this CopyRequestEntity.

Return type:

list[str]

property process_groups

Gets the process_groups of this CopyRequestEntity. The ids of the process groups to be copied.

Returns:

The process_groups of this CopyRequestEntity.

Return type:

list[str]

property processors

Gets the processors of this CopyRequestEntity. The ids of the processors to be copied.

Returns:

The processors of this CopyRequestEntity.

Return type:

list[str]

property remote_process_groups

Gets the remote_process_groups of this CopyRequestEntity. The ids of the remote process groups to be copied.

Returns:

The remote_process_groups of this CopyRequestEntity.

Return type:

list[str]

swagger_types = {'connections': 'list[str]', 'funnels': 'list[str]', 'input_ports': 'list[str]', 'labels': 'list[str]', 'output_ports': 'list[str]', 'process_groups': 'list[str]', 'processors': 'list[str]', 'remote_process_groups': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CopyResponseEntity(connections=None, external_controller_service_references=None, funnels=None, id=None, input_ports=None, labels=None, output_ports=None, parameter_contexts=None, parameter_providers=None, process_groups=None, processors=None, remote_process_groups=None)

Bases: object

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

CopyResponseEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(connections=None, external_controller_service_references=None, funnels=None, id=None, input_ports=None, labels=None, output_ports=None, parameter_contexts=None, parameter_providers=None, process_groups=None, processors=None, remote_process_groups=None)

CopyResponseEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'connections': 'connections', 'external_controller_service_references': 'externalControllerServiceReferences', 'funnels': 'funnels', 'id': 'id', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'parameter_contexts': 'parameterContexts', 'parameter_providers': 'parameterProviders', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

property connections

Gets the connections of this CopyResponseEntity. The connections being copied.

Returns:

The connections of this CopyResponseEntity.

Return type:

list[VersionedConnection]

property external_controller_service_references

Gets the external_controller_service_references of this CopyResponseEntity. The external controller service references.

Returns:

The external_controller_service_references of this CopyResponseEntity.

Return type:

dict(str, ExternalControllerServiceReference)

property funnels

Gets the funnels of this CopyResponseEntity. The funnels being copied.

Returns:

The funnels of this CopyResponseEntity.

Return type:

list[VersionedFunnel]

property id

Gets the id of this CopyResponseEntity. The id for this copy action.

Returns:

The id of this CopyResponseEntity.

Return type:

str

property input_ports

Gets the input_ports of this CopyResponseEntity. The input ports being copied.

Returns:

The input_ports of this CopyResponseEntity.

Return type:

list[VersionedPort]

property labels

Gets the labels of this CopyResponseEntity. The labels being copied.

Returns:

The labels of this CopyResponseEntity.

Return type:

list[VersionedLabel]

property output_ports

Gets the output_ports of this CopyResponseEntity. The output ports being copied.

Returns:

The output_ports of this CopyResponseEntity.

Return type:

list[VersionedPort]

property parameter_contexts

Gets the parameter_contexts of this CopyResponseEntity. The referenced parameter contexts.

Returns:

The parameter_contexts of this CopyResponseEntity.

Return type:

dict(str, VersionedParameterContext)

property parameter_providers

Gets the parameter_providers of this CopyResponseEntity. The referenced parameter providers.

Returns:

The parameter_providers of this CopyResponseEntity.

Return type:

dict(str, ParameterProviderReference)

property process_groups

Gets the process_groups of this CopyResponseEntity. The process groups being copied.

Returns:

The process_groups of this CopyResponseEntity.

Return type:

list[VersionedProcessGroup]

property processors

Gets the processors of this CopyResponseEntity. The processors being copied.

Returns:

The processors of this CopyResponseEntity.

Return type:

list[VersionedProcessor]

property remote_process_groups

Gets the remote_process_groups of this CopyResponseEntity. The remote process groups being copied.

Returns:

The remote_process_groups of this CopyResponseEntity.

Return type:

list[VersionedRemoteProcessGroup]

swagger_types = {'connections': 'list[VersionedConnection]', 'external_controller_service_references': 'dict(str, ExternalControllerServiceReference)', 'funnels': 'list[VersionedFunnel]', 'id': 'str', 'input_ports': 'list[VersionedPort]', 'labels': 'list[VersionedLabel]', 'output_ports': 'list[VersionedPort]', 'parameter_contexts': 'dict(str, VersionedParameterContext)', 'parameter_providers': 'dict(str, ParameterProviderReference)', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CopySnippetRequestEntity(disconnected_node_acknowledged=None, origin_x=None, origin_y=None, snippet_id=None)

Bases: object

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

CopySnippetRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, origin_x=None, origin_y=None, snippet_id=None)

CopySnippetRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'origin_x': 'originX', 'origin_y': 'originY', 'snippet_id': 'snippetId'}

property 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

property 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

property 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

property snippet_id

Gets the snippet_id of this CopySnippetRequestEntity. The identifier of the snippet.

Returns:

The snippet_id of this CopySnippetRequestEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'origin_x': 'float', 'origin_y': 'float', 'snippet_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CounterDTO(context=None, id=None, name=None, value=None, value_count=None)

Bases: object

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

CounterDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(context=None, id=None, name=None, value=None, value_count=None)

CounterDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'context': 'context', 'id': 'id', 'name': 'name', 'value': 'value', 'value_count': 'valueCount'}

property context

Gets the context of this CounterDTO. The context of the counter.

Returns:

The context of this CounterDTO.

Return type:

str

property id

Gets the id of this CounterDTO. The id of the counter.

Returns:

The id of this CounterDTO.

Return type:

str

property name

Gets the name of this CounterDTO. The name of the counter.

Returns:

The name of this CounterDTO.

Return type:

str

swagger_types = {'context': 'str', 'id': 'str', 'name': 'str', 'value': 'str', 'value_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this CounterDTO. The value of the counter.

Returns:

The value of this CounterDTO.

Return type:

str

property value_count

Gets the value_count of this CounterDTO. The value count.

Returns:

The value_count of this CounterDTO.

Return type:

int

class nipyapi.nifi.models.CounterEntity(counter=None)

Bases: object

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

CounterEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(counter=None)

CounterEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'counter': 'counter'}

property counter

Gets the counter of this CounterEntity.

Returns:

The counter of this CounterEntity.

Return type:

CounterDTO

swagger_types = {'counter': 'CounterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CountersDTO(aggregate_snapshot=None, node_snapshots=None)

Bases: object

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

CountersDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, node_snapshots=None)

CountersDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this CountersDTO.

Returns:

The aggregate_snapshot of this CountersDTO.

Return type:

CountersSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'node_snapshots': 'nodeSnapshots'}

property node_snapshots

Gets the node_snapshots of this CountersDTO. A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Returns:

The node_snapshots of this CountersDTO.

Return type:

list[NodeCountersSnapshotDTO]

swagger_types = {'aggregate_snapshot': 'CountersSnapshotDTO', 'node_snapshots': 'list[NodeCountersSnapshotDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CountersEntity(counters=None)

Bases: object

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

CountersEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(counters=None)

CountersEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'counters': 'counters'}

property counters

Gets the counters of this CountersEntity.

Returns:

The counters of this CountersEntity.

Return type:

CountersDTO

swagger_types = {'counters': 'CountersDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CountersSnapshotDTO(counters=None, generated=None)

Bases: object

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

CountersSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(counters=None, generated=None)

CountersSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property counters

Gets the counters of this CountersSnapshotDTO. All counters in the NiFi.

Returns:

The counters of this CountersSnapshotDTO.

Return type:

list[CounterDTO]

property generated

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

Returns:

The generated of this CountersSnapshotDTO.

Return type:

str

swagger_types = {'counters': 'list[CounterDTO]', 'generated': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CreateActiveRequestEntity(disconnected_node_acknowledged=None, process_group_id=None)

Bases: object

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

CreateActiveRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, process_group_id=None)

CreateActiveRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_id': 'processGroupId'}

property 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

property process_group_id

Gets the process_group_id of this CreateActiveRequestEntity. The Process Group ID that this active request will update

Returns:

The process_group_id of this CreateActiveRequestEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.CurrentUserEntity(anonymous=None, can_version_flows=None, component_restriction_permissions=None, controller_permissions=None, counters_permissions=None, identity=None, logout_supported=None, parameter_context_permissions=None, policies_permissions=None, provenance_permissions=None, restricted_components_permissions=None, system_permissions=None, tenants_permissions=None)

Bases: object

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

CurrentUserEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(anonymous=None, can_version_flows=None, component_restriction_permissions=None, controller_permissions=None, counters_permissions=None, identity=None, logout_supported=None, parameter_context_permissions=None, policies_permissions=None, provenance_permissions=None, restricted_components_permissions=None, system_permissions=None, tenants_permissions=None)

CurrentUserEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'logout_supported': 'logoutSupported', 'parameter_context_permissions': 'parameterContextPermissions', 'policies_permissions': 'policiesPermissions', 'provenance_permissions': 'provenancePermissions', 'restricted_components_permissions': 'restrictedComponentsPermissions', 'system_permissions': 'systemPermissions', 'tenants_permissions': 'tenantsPermissions'}

property 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

property 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]

property controller_permissions

Gets the controller_permissions of this CurrentUserEntity.

Returns:

The controller_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

property counters_permissions

Gets the counters_permissions of this CurrentUserEntity.

Returns:

The counters_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

property identity

Gets the identity of this CurrentUserEntity. The user identity being serialized.

Returns:

The identity of this CurrentUserEntity.

Return type:

str

property logout_supported

Gets the logout_supported of this CurrentUserEntity. Whether the system is configured to support logout operations based on current user authentication status

Returns:

The logout_supported of this CurrentUserEntity.

Return type:

bool

property parameter_context_permissions

Gets the parameter_context_permissions of this CurrentUserEntity.

Returns:

The parameter_context_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

property policies_permissions

Gets the policies_permissions of this CurrentUserEntity.

Returns:

The policies_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

property provenance_permissions

Gets the provenance_permissions of this CurrentUserEntity.

Returns:

The provenance_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

property restricted_components_permissions

Gets the restricted_components_permissions of this CurrentUserEntity.

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', 'logout_supported': 'bool', 'parameter_context_permissions': 'PermissionsDTO', 'policies_permissions': 'PermissionsDTO', 'provenance_permissions': 'PermissionsDTO', 'restricted_components_permissions': 'PermissionsDTO', 'system_permissions': 'PermissionsDTO', 'tenants_permissions': 'PermissionsDTO'}

property system_permissions

Gets the system_permissions of this CurrentUserEntity.

Returns:

The system_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

property tenants_permissions

Gets the tenants_permissions of this CurrentUserEntity.

Returns:

The tenants_permissions of this CurrentUserEntity.

Return type:

PermissionsDTO

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.DateTimeParameter(date_time=None)

Bases: object

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

DateTimeParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(date_time=None)

DateTimeParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'date_time': 'dateTime'}

property date_time

Gets the date_time of this DateTimeParameter.

Returns:

The date_time of this DateTimeParameter.

Return type:

datetime

swagger_types = {'date_time': 'datetime'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.DefinedType(artifact=None, group=None, type=None, type_description=None, version=None)

Bases: object

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

DefinedType - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact=None, group=None, type=None, type_description=None, version=None)

DefinedType - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact

Gets the artifact of this DefinedType. The artifact name of the bundle that provides the referenced type.

Returns:

The artifact of this DefinedType.

Return type:

str

attribute_map = {'artifact': 'artifact', 'group': 'group', 'type': 'type', 'type_description': 'typeDescription', 'version': 'version'}

property group

Gets the group of this DefinedType. The group name of the bundle that provides the referenced type.

Returns:

The group of this DefinedType.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this DefinedType. The fully-qualified class type

Returns:

The type of this DefinedType.

Return type:

str

property type_description

Gets the type_description of this DefinedType. The description of the type.

Returns:

The type_description of this DefinedType.

Return type:

str

property version

Gets the version of this DefinedType. The version of the bundle that provides the referenced type.

Returns:

The version of this DefinedType.

Return type:

str

class nipyapi.nifi.models.DifferenceDTO(difference=None, difference_type=None)

Bases: object

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

DifferenceDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(difference=None, difference_type=None)

DifferenceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'difference': 'difference', 'difference_type': 'differenceType'}

property difference

Gets the difference of this DifferenceDTO. Description of the difference

Returns:

The difference of this DifferenceDTO.

Return type:

str

property difference_type

Gets the difference_type of this DifferenceDTO. The type of difference

Returns:

The difference_type of this DifferenceDTO.

Return type:

str

swagger_types = {'difference': 'str', 'difference_type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.DimensionsDTO(height=None, width=None)

Bases: object

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

DimensionsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(height=None, width=None)

DimensionsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'height': 'height', 'width': 'width'}

property height

Gets the height of this DimensionsDTO. The height of the label in pixels when at a 1:1 scale.

Returns:

The height of this DimensionsDTO.

Return type:

float

swagger_types = {'height': 'float', 'width': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.DocumentedTypeDTO(bundle=None, controller_service_apis=None, deprecation_reason=None, description=None, explicit_restrictions=None, restricted=None, tags=None, type=None, usage_restriction=None)

Bases: object

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

DocumentedTypeDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, controller_service_apis=None, deprecation_reason=None, description=None, explicit_restrictions=None, restricted=None, tags=None, type=None, usage_restriction=None)

DocumentedTypeDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bundle

Gets the bundle of this DocumentedTypeDTO.

Returns:

The bundle of this DocumentedTypeDTO.

Return type:

BundleDTO

property 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]

property 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

property description

Gets the description of this DocumentedTypeDTO. The description of the type.

Returns:

The description of this DocumentedTypeDTO.

Return type:

str

property 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]

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

property tags

Gets the tags of this DocumentedTypeDTO. The tags associated with this type.

Returns:

The tags of this DocumentedTypeDTO.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this DocumentedTypeDTO. The fully qualified name of the type.

Returns:

The type of this DocumentedTypeDTO.

Return type:

str

property 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

class nipyapi.nifi.models.DropRequestDTO(current=None, current_count=None, current_size=None, dropped=None, dropped_count=None, dropped_size=None, failure_reason=None, finished=None, id=None, last_updated=None, original=None, original_count=None, original_size=None, percent_completed=None, state=None, submission_time=None, uri=None)

Bases: object

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

DropRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current=None, current_count=None, current_size=None, dropped=None, dropped_count=None, dropped_size=None, failure_reason=None, finished=None, id=None, last_updated=None, original=None, original_count=None, original_size=None, percent_completed=None, state=None, submission_time=None, uri=None)

DropRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property finished

Gets the finished of this DropRequestDTO. Whether the query has finished.

Returns:

The finished of this DropRequestDTO.

Return type:

bool

property id

Gets the id of this DropRequestDTO. The id for this drop request.

Returns:

The id of this DropRequestDTO.

Return type:

str

property 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

property 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

property 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

property 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

property percent_completed

Gets the percent_completed of this DropRequestDTO. The current percent complete.

Returns:

The percent_completed of this DropRequestDTO.

Return type:

int

property state

Gets the state of this DropRequestDTO. The current state of the drop request.

Returns:

The state of this DropRequestDTO.

Return type:

str

property submission_time

Gets the submission_time of this DropRequestDTO. The timestamp when the query was submitted.

Returns:

The submission_time of this DropRequestDTO.

Return type:

str

swagger_types = {'current': 'str', 'current_count': 'int', 'current_size': 'int', 'dropped': 'str', 'dropped_count': 'int', 'dropped_size': 'int', 'failure_reason': 'str', 'finished': 'bool', 'id': 'str', 'last_updated': 'str', 'original': 'str', 'original_count': 'int', 'original_size': 'int', 'percent_completed': 'int', 'state': 'str', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.DropRequestEntity(drop_request=None)

Bases: object

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

DropRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(drop_request=None)

DropRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'drop_request': 'dropRequest'}

property drop_request

Gets the drop_request of this DropRequestEntity.

Returns:

The drop_request of this DropRequestEntity.

Return type:

DropRequestDTO

swagger_types = {'drop_request': 'DropRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.DynamicProperty(description=None, expression_language_scope=None, name=None, value=None)

Bases: object

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

DynamicProperty - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, expression_language_scope=None, name=None, value=None)

DynamicProperty - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'expression_language_scope': 'expressionLanguageScope', 'name': 'name', 'value': 'value'}

property description

Gets the description of this DynamicProperty. The description of the dynamic property

Returns:

The description of this DynamicProperty.

Return type:

str

property expression_language_scope

Gets the expression_language_scope of this DynamicProperty. The scope of the expression language support

Returns:

The expression_language_scope of this DynamicProperty.

Return type:

str

property name

Gets the name of this DynamicProperty. The description of the dynamic property name

Returns:

The name of this DynamicProperty.

Return type:

str

swagger_types = {'description': 'str', 'expression_language_scope': 'str', 'name': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this DynamicProperty. The description of the dynamic property value

Returns:

The value of this DynamicProperty.

Return type:

str

class nipyapi.nifi.models.DynamicRelationship(description=None, name=None)

Bases: object

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

DynamicRelationship - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None)

DynamicRelationship - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this DynamicRelationship. The description of the dynamic relationship

Returns:

The description of this DynamicRelationship.

Return type:

str

property name

Gets the name of this DynamicRelationship. The description of the dynamic relationship name

Returns:

The name of this DynamicRelationship.

Return type:

str

swagger_types = {'description': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ExplicitRestrictionDTO(explanation=None, required_permission=None)

Bases: object

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

ExplicitRestrictionDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(explanation=None, required_permission=None)

ExplicitRestrictionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'explanation': 'explanation', 'required_permission': 'requiredPermission'}

property explanation

Gets the explanation of this ExplicitRestrictionDTO. The description of why the usage of this component is restricted for this required permission.

Returns:

The explanation of this ExplicitRestrictionDTO.

Return type:

str

property required_permission

Gets the required_permission of this ExplicitRestrictionDTO.

Returns:

The required_permission of this ExplicitRestrictionDTO.

Return type:

RequiredPermissionDTO

swagger_types = {'explanation': 'str', 'required_permission': 'RequiredPermissionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ExternalControllerServiceReference(identifier=None, name=None)

Bases: object

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

ExternalControllerServiceReference - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(identifier=None, name=None)

ExternalControllerServiceReference - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'identifier': 'identifier', 'name': 'name'}

property identifier

Gets the identifier of this ExternalControllerServiceReference. The identifier of the controller service

Returns:

The identifier of this ExternalControllerServiceReference.

Return type:

str

property name

Gets the name of this ExternalControllerServiceReference. The name of the controller service

Returns:

The name of this ExternalControllerServiceReference.

Return type:

str

swagger_types = {'identifier': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowAnalysisResultEntity(flow_analysis_pending=None, rule_violations=None, rules=None)

Bases: object

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

FlowAnalysisResultEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow_analysis_pending=None, rule_violations=None, rules=None)

FlowAnalysisResultEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_analysis_pending': 'flowAnalysisPending', 'rule_violations': 'ruleViolations', 'rules': 'rules'}

property flow_analysis_pending

Gets the flow_analysis_pending of this FlowAnalysisResultEntity.

Returns:

The flow_analysis_pending of this FlowAnalysisResultEntity.

Return type:

bool

property rule_violations

Gets the rule_violations of this FlowAnalysisResultEntity.

Returns:

The rule_violations of this FlowAnalysisResultEntity.

Return type:

list[FlowAnalysisRuleViolationDTO]

property rules

Gets the rules of this FlowAnalysisResultEntity.

Returns:

The rules of this FlowAnalysisResultEntity.

Return type:

list[FlowAnalysisRuleDTO]

swagger_types = {'flow_analysis_pending': 'bool', 'rule_violations': 'list[FlowAnalysisRuleViolationDTO]', 'rules': 'list[FlowAnalysisRuleDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowAnalysisRuleDTO(bundle=None, comments=None, deprecated=None, descriptors=None, enforcement_policy=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, restricted=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

Bases: object

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

FlowAnalysisRuleDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, comments=None, deprecated=None, descriptors=None, enforcement_policy=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, restricted=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

FlowAnalysisRuleDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bundle': 'bundle', 'comments': 'comments', 'deprecated': 'deprecated', 'descriptors': 'descriptors', 'enforcement_policy': 'enforcementPolicy', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'properties': 'properties', 'restricted': 'restricted', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'state': 'state', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

property bundle

Gets the bundle of this FlowAnalysisRuleDTO.

Returns:

The bundle of this FlowAnalysisRuleDTO.

Return type:

BundleDTO

property comments

Gets the comments of this FlowAnalysisRuleDTO. The comments of the flow analysis rule.

Returns:

The comments of this FlowAnalysisRuleDTO.

Return type:

str

property deprecated

Gets the deprecated of this FlowAnalysisRuleDTO. Whether the flow analysis rule has been deprecated.

Returns:

The deprecated of this FlowAnalysisRuleDTO.

Return type:

bool

property descriptors

Gets the descriptors of this FlowAnalysisRuleDTO. The descriptors for the flow analysis rules properties.

Returns:

The descriptors of this FlowAnalysisRuleDTO.

Return type:

dict(str, PropertyDescriptorDTO)

property enforcement_policy

Gets the enforcement_policy of this FlowAnalysisRuleDTO. Enforcement Policy.

Returns:

The enforcement_policy of this FlowAnalysisRuleDTO.

Return type:

str

property extension_missing

Gets the extension_missing of this FlowAnalysisRuleDTO. Whether the underlying extension is missing.

Returns:

The extension_missing of this FlowAnalysisRuleDTO.

Return type:

bool

property id

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

Returns:

The id of this FlowAnalysisRuleDTO.

Return type:

str

property multiple_versions_available

Gets the multiple_versions_available of this FlowAnalysisRuleDTO. Whether the flow analysis rule has multiple versions available.

Returns:

The multiple_versions_available of this FlowAnalysisRuleDTO.

Return type:

bool

property name

Gets the name of this FlowAnalysisRuleDTO. The name of the flow analysis rule.

Returns:

The name of this FlowAnalysisRuleDTO.

Return type:

str

property parent_group_id

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

Returns:

The parent_group_id of this FlowAnalysisRuleDTO.

Return type:

str

property persists_state

Gets the persists_state of this FlowAnalysisRuleDTO. Whether the flow analysis rule persists state.

Returns:

The persists_state of this FlowAnalysisRuleDTO.

Return type:

bool

property position

Gets the position of this FlowAnalysisRuleDTO.

Returns:

The position of this FlowAnalysisRuleDTO.

Return type:

PositionDTO

property properties

Gets the properties of this FlowAnalysisRuleDTO. The properties of the flow analysis rule.

Returns:

The properties of this FlowAnalysisRuleDTO.

Return type:

dict(str, str)

property restricted

Gets the restricted of this FlowAnalysisRuleDTO. Whether the flow analysis rule requires elevated privileges.

Returns:

The restricted of this FlowAnalysisRuleDTO.

Return type:

bool

property sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this FlowAnalysisRuleDTO. Set of sensitive dynamic property names

Returns:

The sensitive_dynamic_property_names of this FlowAnalysisRuleDTO.

Return type:

list[str]

property state

Gets the state of this FlowAnalysisRuleDTO. The state of the flow analysis rule.

Returns:

The state of this FlowAnalysisRuleDTO.

Return type:

str

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this FlowAnalysisRuleDTO. Whether the flow analysis rule supports sensitive dynamic properties.

Returns:

The supports_sensitive_dynamic_properties of this FlowAnalysisRuleDTO.

Return type:

bool

swagger_types = {'bundle': 'BundleDTO', 'comments': 'str', 'deprecated': 'bool', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'enforcement_policy': 'str', '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', 'sensitive_dynamic_property_names': 'list[str]', 'state': 'str', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this FlowAnalysisRuleDTO. The fully qualified type of the flow analysis rule.

Returns:

The type of this FlowAnalysisRuleDTO.

Return type:

str

property validation_errors

Gets the validation_errors of this FlowAnalysisRuleDTO. Gets the validation errors from the flow analysis rule. These validation errors represent the problems with the flow analysis rule that must be resolved before it can be scheduled to run.

Returns:

The validation_errors of this FlowAnalysisRuleDTO.

Return type:

list[str]

property validation_status

Gets the validation_status of this FlowAnalysisRuleDTO. Indicates whether the Flow Analysis Rule is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Flow Analysis Rule is valid)

Returns:

The validation_status of this FlowAnalysisRuleDTO.

Return type:

str

property versioned_component_id

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

Returns:

The versioned_component_id of this FlowAnalysisRuleDTO.

Return type:

str

class nipyapi.nifi.models.FlowAnalysisRuleDefinition(additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

Bases: object

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

FlowAnalysisRuleDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

FlowAnalysisRuleDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property additional_details

Gets the additional_details of this FlowAnalysisRuleDefinition. Indicates if the component has additional details documentation

Returns:

The additional_details of this FlowAnalysisRuleDefinition.

Return type:

bool

property artifact

Gets the artifact of this FlowAnalysisRuleDefinition. The artifact name of the bundle that provides the referenced type.

Returns:

The artifact of this FlowAnalysisRuleDefinition.

Return type:

str

attribute_map = {'additional_details': 'additionalDetails', 'artifact': 'artifact', 'build_info': 'buildInfo', 'deprecated': 'deprecated', 'deprecation_alternatives': 'deprecationAlternatives', 'deprecation_reason': 'deprecationReason', 'dynamic_properties': 'dynamicProperties', 'explicit_restrictions': 'explicitRestrictions', 'group': 'group', 'property_descriptors': 'propertyDescriptors', 'provided_api_implementations': 'providedApiImplementations', 'restricted': 'restricted', 'restricted_explanation': 'restrictedExplanation', 'see_also': 'seeAlso', 'stateful': 'stateful', 'supports_dynamic_properties': 'supportsDynamicProperties', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'system_resource_considerations': 'systemResourceConsiderations', 'tags': 'tags', 'type': 'type', 'type_description': 'typeDescription', 'version': 'version'}

property build_info

Gets the build_info of this FlowAnalysisRuleDefinition.

Returns:

The build_info of this FlowAnalysisRuleDefinition.

Return type:

BuildInfo

property deprecated

Gets the deprecated of this FlowAnalysisRuleDefinition. Whether or not the component has been deprecated

Returns:

The deprecated of this FlowAnalysisRuleDefinition.

Return type:

bool

property deprecation_alternatives

Gets the deprecation_alternatives of this FlowAnalysisRuleDefinition. If this component has been deprecated, this optional field provides alternatives to use

Returns:

The deprecation_alternatives of this FlowAnalysisRuleDefinition.

Return type:

list[str]

property deprecation_reason

Gets the deprecation_reason of this FlowAnalysisRuleDefinition. If this component has been deprecated, this optional field can be used to provide an explanation

Returns:

The deprecation_reason of this FlowAnalysisRuleDefinition.

Return type:

str

property dynamic_properties

Gets the dynamic_properties of this FlowAnalysisRuleDefinition. Describes the dynamic properties supported by this component

Returns:

The dynamic_properties of this FlowAnalysisRuleDefinition.

Return type:

list[DynamicProperty]

property explicit_restrictions

Gets the explicit_restrictions of this FlowAnalysisRuleDefinition. Explicit restrictions that indicate a require permission to use the component

Returns:

The explicit_restrictions of this FlowAnalysisRuleDefinition.

Return type:

list[Restriction]

property group

Gets the group of this FlowAnalysisRuleDefinition. The group name of the bundle that provides the referenced type.

Returns:

The group of this FlowAnalysisRuleDefinition.

Return type:

str

property property_descriptors

Gets the property_descriptors of this FlowAnalysisRuleDefinition. Descriptions of configuration properties applicable to this component.

Returns:

The property_descriptors of this FlowAnalysisRuleDefinition.

Return type:

dict(str, PropertyDescriptor)

property provided_api_implementations

Gets the provided_api_implementations of this FlowAnalysisRuleDefinition. If this type represents a provider for an interface, this lists the APIs it implements

Returns:

The provided_api_implementations of this FlowAnalysisRuleDefinition.

Return type:

list[DefinedType]

property restricted

Gets the restricted of this FlowAnalysisRuleDefinition. Whether or not the component has a general restriction

Returns:

The restricted of this FlowAnalysisRuleDefinition.

Return type:

bool

property restricted_explanation

Gets the restricted_explanation of this FlowAnalysisRuleDefinition. An optional description of the general restriction

Returns:

The restricted_explanation of this FlowAnalysisRuleDefinition.

Return type:

str

property see_also

Gets the see_also of this FlowAnalysisRuleDefinition. The names of other component types that may be related

Returns:

The see_also of this FlowAnalysisRuleDefinition.

Return type:

list[str]

property stateful

Gets the stateful of this FlowAnalysisRuleDefinition.

Returns:

The stateful of this FlowAnalysisRuleDefinition.

Return type:

Stateful

property supports_dynamic_properties

Gets the supports_dynamic_properties of this FlowAnalysisRuleDefinition. Whether or not this component makes use of dynamic (user-set) properties.

Returns:

The supports_dynamic_properties of this FlowAnalysisRuleDefinition.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this FlowAnalysisRuleDefinition. Whether or not this component makes use of sensitive dynamic (user-set) properties.

Returns:

The supports_sensitive_dynamic_properties of this FlowAnalysisRuleDefinition.

Return type:

bool

swagger_types = {'additional_details': 'bool', 'artifact': 'str', 'build_info': 'BuildInfo', 'deprecated': 'bool', 'deprecation_alternatives': 'list[str]', 'deprecation_reason': 'str', 'dynamic_properties': 'list[DynamicProperty]', 'explicit_restrictions': 'list[Restriction]', 'group': 'str', 'property_descriptors': 'dict(str, PropertyDescriptor)', 'provided_api_implementations': 'list[DefinedType]', 'restricted': 'bool', 'restricted_explanation': 'str', 'see_also': 'list[str]', 'stateful': 'Stateful', 'supports_dynamic_properties': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'system_resource_considerations': 'list[SystemResourceConsideration]', 'tags': 'list[str]', 'type': 'str', 'type_description': 'str', 'version': 'str'}

property system_resource_considerations

Gets the system_resource_considerations of this FlowAnalysisRuleDefinition. The system resource considerations for the given component

Returns:

The system_resource_considerations of this FlowAnalysisRuleDefinition.

Return type:

list[SystemResourceConsideration]

property tags

Gets the tags of this FlowAnalysisRuleDefinition. The tags associated with this type

Returns:

The tags of this FlowAnalysisRuleDefinition.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this FlowAnalysisRuleDefinition. The fully-qualified class type

Returns:

The type of this FlowAnalysisRuleDefinition.

Return type:

str

property type_description

Gets the type_description of this FlowAnalysisRuleDefinition. The description of the type.

Returns:

The type_description of this FlowAnalysisRuleDefinition.

Return type:

str

property version

Gets the version of this FlowAnalysisRuleDefinition. The version of the bundle that provides the referenced type.

Returns:

The version of this FlowAnalysisRuleDefinition.

Return type:

str

class nipyapi.nifi.models.FlowAnalysisRuleEntity(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None)

Bases: object

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

FlowAnalysisRuleEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None)

FlowAnalysisRuleEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this FlowAnalysisRuleEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this FlowAnalysisRuleEntity.

Returns:

The component of this FlowAnalysisRuleEntity.

Return type:

FlowAnalysisRuleDTO

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this FlowAnalysisRuleEntity.

Return type:

bool

property id

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

Returns:

The id of this FlowAnalysisRuleEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this FlowAnalysisRuleEntity.

Returns:

The operate_permissions of this FlowAnalysisRuleEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this FlowAnalysisRuleEntity.

Returns:

The permissions of this FlowAnalysisRuleEntity.

Return type:

PermissionsDTO

property position

Gets the position of this FlowAnalysisRuleEntity.

Returns:

The position of this FlowAnalysisRuleEntity.

Return type:

PositionDTO

property revision

Gets the revision of this FlowAnalysisRuleEntity.

Returns:

The revision of this FlowAnalysisRuleEntity.

Return type:

RevisionDTO

property status

Gets the status of this FlowAnalysisRuleEntity.

Returns:

The status of this FlowAnalysisRuleEntity.

Return type:

FlowAnalysisRuleStatusDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this FlowAnalysisRuleEntity.

Return type:

str

class nipyapi.nifi.models.FlowAnalysisRuleRunStatusEntity(disconnected_node_acknowledged=None, revision=None, state=None)

Bases: object

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

FlowAnalysisRuleRunStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, revision=None, state=None)

FlowAnalysisRuleRunStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision', 'state': 'state'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this FlowAnalysisRuleRunStatusEntity.

Return type:

bool

property revision

Gets the revision of this FlowAnalysisRuleRunStatusEntity.

Returns:

The revision of this FlowAnalysisRuleRunStatusEntity.

Return type:

RevisionDTO

property state

Gets the state of this FlowAnalysisRuleRunStatusEntity. The state of the FlowAnalysisRule.

Returns:

The state of this FlowAnalysisRuleRunStatusEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowAnalysisRuleStatusDTO(active_thread_count=None, run_status=None, validation_status=None)

Bases: object

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

FlowAnalysisRuleStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, run_status=None, validation_status=None)

FlowAnalysisRuleStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property active_thread_count

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

Returns:

The active_thread_count of this FlowAnalysisRuleStatusDTO.

Return type:

int

attribute_map = {'active_thread_count': 'activeThreadCount', 'run_status': 'runStatus', 'validation_status': 'validationStatus'}

property run_status

Gets the run_status of this FlowAnalysisRuleStatusDTO. The run status of this FlowAnalysisRule

Returns:

The run_status of this FlowAnalysisRuleStatusDTO.

Return type:

str

swagger_types = {'active_thread_count': 'int', 'run_status': 'str', 'validation_status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property validation_status

Gets the validation_status of this FlowAnalysisRuleStatusDTO. 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 FlowAnalysisRuleStatusDTO.

Return type:

str

class nipyapi.nifi.models.FlowAnalysisRuleTypesEntity(flow_analysis_rule_types=None)

Bases: object

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

FlowAnalysisRuleTypesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow_analysis_rule_types=None)

FlowAnalysisRuleTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_analysis_rule_types': 'flowAnalysisRuleTypes'}

property flow_analysis_rule_types

Gets the flow_analysis_rule_types of this FlowAnalysisRuleTypesEntity.

Returns:

The flow_analysis_rule_types of this FlowAnalysisRuleTypesEntity.

Return type:

list[DocumentedTypeDTO]

swagger_types = {'flow_analysis_rule_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowAnalysisRuleViolationDTO(enabled=None, enforcement_policy=None, group_id=None, issue_id=None, rule_id=None, scope=None, subject_component_type=None, subject_display_name=None, subject_id=None, subject_permission_dto=None, violation_message=None)

Bases: object

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

FlowAnalysisRuleViolationDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(enabled=None, enforcement_policy=None, group_id=None, issue_id=None, rule_id=None, scope=None, subject_component_type=None, subject_display_name=None, subject_id=None, subject_permission_dto=None, violation_message=None)

FlowAnalysisRuleViolationDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'enabled': 'enabled', 'enforcement_policy': 'enforcementPolicy', 'group_id': 'groupId', 'issue_id': 'issueId', 'rule_id': 'ruleId', 'scope': 'scope', 'subject_component_type': 'subjectComponentType', 'subject_display_name': 'subjectDisplayName', 'subject_id': 'subjectId', 'subject_permission_dto': 'subjectPermissionDto', 'violation_message': 'violationMessage'}

property enabled

Gets the enabled of this FlowAnalysisRuleViolationDTO.

Returns:

The enabled of this FlowAnalysisRuleViolationDTO.

Return type:

bool

property enforcement_policy

Gets the enforcement_policy of this FlowAnalysisRuleViolationDTO.

Returns:

The enforcement_policy of this FlowAnalysisRuleViolationDTO.

Return type:

str

property group_id

Gets the group_id of this FlowAnalysisRuleViolationDTO.

Returns:

The group_id of this FlowAnalysisRuleViolationDTO.

Return type:

str

property issue_id

Gets the issue_id of this FlowAnalysisRuleViolationDTO.

Returns:

The issue_id of this FlowAnalysisRuleViolationDTO.

Return type:

str

property rule_id

Gets the rule_id of this FlowAnalysisRuleViolationDTO.

Returns:

The rule_id of this FlowAnalysisRuleViolationDTO.

Return type:

str

property scope

Gets the scope of this FlowAnalysisRuleViolationDTO.

Returns:

The scope of this FlowAnalysisRuleViolationDTO.

Return type:

str

property subject_component_type

Gets the subject_component_type of this FlowAnalysisRuleViolationDTO.

Returns:

The subject_component_type of this FlowAnalysisRuleViolationDTO.

Return type:

str

property subject_display_name

Gets the subject_display_name of this FlowAnalysisRuleViolationDTO.

Returns:

The subject_display_name of this FlowAnalysisRuleViolationDTO.

Return type:

str

property subject_id

Gets the subject_id of this FlowAnalysisRuleViolationDTO.

Returns:

The subject_id of this FlowAnalysisRuleViolationDTO.

Return type:

str

property subject_permission_dto

Gets the subject_permission_dto of this FlowAnalysisRuleViolationDTO.

Returns:

The subject_permission_dto of this FlowAnalysisRuleViolationDTO.

Return type:

PermissionsDTO

swagger_types = {'enabled': 'bool', 'enforcement_policy': 'str', 'group_id': 'str', 'issue_id': 'str', 'rule_id': 'str', 'scope': 'str', 'subject_component_type': 'str', 'subject_display_name': 'str', 'subject_id': 'str', 'subject_permission_dto': 'PermissionsDTO', 'violation_message': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property violation_message

Gets the violation_message of this FlowAnalysisRuleViolationDTO.

Returns:

The violation_message of this FlowAnalysisRuleViolationDTO.

Return type:

str

class nipyapi.nifi.models.FlowAnalysisRulesEntity(current_time=None, flow_analysis_rules=None)

Bases: object

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

FlowAnalysisRulesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, flow_analysis_rules=None)

FlowAnalysisRulesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'current_time': 'currentTime', 'flow_analysis_rules': 'flowAnalysisRules'}

property current_time

Gets the current_time of this FlowAnalysisRulesEntity. The current time on the system.

Returns:

The current_time of this FlowAnalysisRulesEntity.

Return type:

str

property flow_analysis_rules

Gets the flow_analysis_rules of this FlowAnalysisRulesEntity.

Returns:

The flow_analysis_rules of this FlowAnalysisRulesEntity.

Return type:

list[FlowAnalysisRuleEntity]

swagger_types = {'current_time': 'str', 'flow_analysis_rules': 'list[FlowAnalysisRuleEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowBreadcrumbDTO(id=None, name=None, version_control_information=None)

Bases: object

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

FlowBreadcrumbDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None, version_control_information=None)

FlowBreadcrumbDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'name': 'name', 'version_control_information': 'versionControlInformation'}

property id

Gets the id of this FlowBreadcrumbDTO. The id of the group.

Returns:

The id of this FlowBreadcrumbDTO.

Return type:

str

property name

Gets the name of this FlowBreadcrumbDTO. The id of the group.

Returns:

The name of this FlowBreadcrumbDTO.

Return type:

str

swagger_types = {'id': 'str', 'name': 'str', 'version_control_information': 'VersionControlInformationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version_control_information

Gets the version_control_information of this FlowBreadcrumbDTO.

Returns:

The version_control_information of this FlowBreadcrumbDTO.

Return type:

VersionControlInformationDTO

class nipyapi.nifi.models.FlowBreadcrumbEntity(breadcrumb=None, id=None, parent_breadcrumb=None, permissions=None, versioned_flow_state=None)

Bases: object

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

FlowBreadcrumbEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(breadcrumb=None, id=None, parent_breadcrumb=None, permissions=None, versioned_flow_state=None)

FlowBreadcrumbEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'breadcrumb': 'breadcrumb', 'id': 'id', 'parent_breadcrumb': 'parentBreadcrumb', 'permissions': 'permissions', 'versioned_flow_state': 'versionedFlowState'}

property breadcrumb

Gets the breadcrumb of this FlowBreadcrumbEntity.

Returns:

The breadcrumb of this FlowBreadcrumbEntity.

Return type:

FlowBreadcrumbDTO

property id

Gets the id of this FlowBreadcrumbEntity. The id of this ancestor ProcessGroup.

Returns:

The id of this FlowBreadcrumbEntity.

Return type:

str

property parent_breadcrumb

Gets the parent_breadcrumb of this FlowBreadcrumbEntity.

Returns:

The parent_breadcrumb of this FlowBreadcrumbEntity.

Return type:

FlowBreadcrumbEntity

property permissions

Gets the permissions of this FlowBreadcrumbEntity.

Returns:

The permissions of this FlowBreadcrumbEntity.

Return type:

PermissionsDTO

swagger_types = {'breadcrumb': 'FlowBreadcrumbDTO', 'id': 'str', 'parent_breadcrumb': 'FlowBreadcrumbEntity', 'permissions': 'PermissionsDTO', 'versioned_flow_state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.FlowComparisonEntity(component_differences=None)

Bases: object

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

FlowComparisonEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_differences=None)

FlowComparisonEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component_differences': 'componentDifferences'}

property component_differences

Gets the component_differences of this FlowComparisonEntity. The list of differences for each component in the flow that is not the same between the two flows

Returns:

The component_differences of this FlowComparisonEntity.

Return type:

list[ComponentDifferenceDTO]

swagger_types = {'component_differences': 'list[ComponentDifferenceDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowConfigurationDTO(current_time=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, supports_managed_authorizer=None, time_offset=None)

Bases: object

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

FlowConfigurationDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, supports_managed_authorizer=None, time_offset=None)

FlowConfigurationDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'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'}

property 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

property 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

property 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

property 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

property 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

property 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 = {'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'}

property time_offset

Gets the time_offset of this FlowConfigurationDTO. The time offset of the system.

Returns:

The time_offset of this FlowConfigurationDTO.

Return type:

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowConfigurationEntity(flow_configuration=None)

Bases: object

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

FlowConfigurationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow_configuration=None)

FlowConfigurationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_configuration': 'flowConfiguration'}

property flow_configuration

Gets the flow_configuration of this FlowConfigurationEntity.

Returns:

The flow_configuration of this FlowConfigurationEntity.

Return type:

FlowConfigurationDTO

swagger_types = {'flow_configuration': 'FlowConfigurationDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowDTO(connections=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None)

Bases: object

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

FlowDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(connections=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None)

FlowDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'connections': 'connections', 'funnels': 'funnels', 'input_ports': 'inputPorts', 'labels': 'labels', 'output_ports': 'outputPorts', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups'}

property connections

Gets the connections of this FlowDTO. The connections in this flow.

Returns:

The connections of this FlowDTO.

Return type:

list[ConnectionEntity]

property funnels

Gets the funnels of this FlowDTO. The funnels in this flow.

Returns:

The funnels of this FlowDTO.

Return type:

list[FunnelEntity]

property 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]

property labels

Gets the labels of this FlowDTO. The labels in this flow.

Returns:

The labels of this FlowDTO.

Return type:

list[LabelEntity]

property 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]

property 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]

property processors

Gets the processors of this FlowDTO. The processors in this flow.

Returns:

The processors of this FlowDTO.

Return type:

list[ProcessorEntity]

property remote_process_groups

Gets the remote_process_groups of this FlowDTO. The remote process groups in this flow.

Returns:

The remote_process_groups of this FlowDTO.

Return type:

list[RemoteProcessGroupEntity]

swagger_types = {'connections': 'list[ConnectionEntity]', 'funnels': 'list[FunnelEntity]', 'input_ports': 'list[PortEntity]', 'labels': 'list[LabelEntity]', 'output_ports': 'list[PortEntity]', 'process_groups': 'list[ProcessGroupEntity]', 'processors': 'list[ProcessorEntity]', 'remote_process_groups': 'list[RemoteProcessGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowEntity(flow=None)

Bases: object

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

FlowEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow=None)

FlowEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow': 'flow'}

property flow

Gets the flow of this FlowEntity.

Returns:

The flow of this FlowEntity.

Return type:

FlowDTO

swagger_types = {'flow': 'FlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowFileDTO(attributes=None, cluster_node_address=None, cluster_node_id=None, content_claim_container=None, content_claim_file_size=None, content_claim_file_size_bytes=None, content_claim_identifier=None, content_claim_offset=None, content_claim_section=None, filename=None, lineage_duration=None, mime_type=None, penalized=None, penalty_expires_in=None, position=None, queued_duration=None, size=None, uri=None, uuid=None)

Bases: object

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

FlowFileDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(attributes=None, cluster_node_address=None, cluster_node_id=None, content_claim_container=None, content_claim_file_size=None, content_claim_file_size_bytes=None, content_claim_identifier=None, content_claim_offset=None, content_claim_section=None, filename=None, lineage_duration=None, mime_type=None, penalized=None, penalty_expires_in=None, position=None, queued_duration=None, size=None, uri=None, uuid=None)

FlowFileDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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', 'mime_type': 'mimeType', 'penalized': 'penalized', 'penalty_expires_in': 'penaltyExpiresIn', 'position': 'position', 'queued_duration': 'queuedDuration', 'size': 'size', 'uri': 'uri', 'uuid': 'uuid'}

property attributes

Gets the attributes of this FlowFileDTO. The FlowFile attributes.

Returns:

The attributes of this FlowFileDTO.

Return type:

dict(str, str)

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property filename

Gets the filename of this FlowFileDTO. The FlowFile filename.

Returns:

The filename of this FlowFileDTO.

Return type:

str

property 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

property mime_type

Gets the mime_type of this FlowFileDTO. The FlowFile mime type.

Returns:

The mime_type of this FlowFileDTO.

Return type:

str

property penalized

Gets the penalized of this FlowFileDTO. If the FlowFile is penalized.

Returns:

The penalized of this FlowFileDTO.

Return type:

bool

property 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

property position

Gets the position of this FlowFileDTO. The FlowFile’s position in the queue.

Returns:

The position of this FlowFileDTO.

Return type:

int

property 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

property 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', 'mime_type': 'str', 'penalized': 'bool', 'penalty_expires_in': 'int', 'position': 'int', 'queued_duration': 'int', 'size': 'int', 'uri': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property uuid

Gets the uuid of this FlowFileDTO. The FlowFile UUID.

Returns:

The uuid of this FlowFileDTO.

Return type:

str

class nipyapi.nifi.models.FlowFileEntity(flow_file=None)

Bases: object

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

FlowFileEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow_file=None)

FlowFileEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_file': 'flowFile'}

property flow_file

Gets the flow_file of this FlowFileEntity.

Returns:

The flow_file of this FlowFileEntity.

Return type:

FlowFileDTO

swagger_types = {'flow_file': 'FlowFileDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowFileSummaryDTO(cluster_node_address=None, cluster_node_id=None, filename=None, lineage_duration=None, mime_type=None, penalized=None, penalty_expires_in=None, position=None, queued_duration=None, size=None, uri=None, uuid=None)

Bases: object

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

FlowFileSummaryDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cluster_node_address=None, cluster_node_id=None, filename=None, lineage_duration=None, mime_type=None, penalized=None, penalty_expires_in=None, position=None, queued_duration=None, size=None, uri=None, uuid=None)

FlowFileSummaryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'filename': 'filename', 'lineage_duration': 'lineageDuration', 'mime_type': 'mimeType', 'penalized': 'penalized', 'penalty_expires_in': 'penaltyExpiresIn', 'position': 'position', 'queued_duration': 'queuedDuration', 'size': 'size', 'uri': 'uri', 'uuid': 'uuid'}

property 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

property 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

property filename

Gets the filename of this FlowFileSummaryDTO. The FlowFile filename.

Returns:

The filename of this FlowFileSummaryDTO.

Return type:

str

property 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

property mime_type

Gets the mime_type of this FlowFileSummaryDTO. The FlowFile mime type.

Returns:

The mime_type of this FlowFileSummaryDTO.

Return type:

str

property penalized

Gets the penalized of this FlowFileSummaryDTO. If the FlowFile is penalized.

Returns:

The penalized of this FlowFileSummaryDTO.

Return type:

bool

property 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

property position

Gets the position of this FlowFileSummaryDTO. The FlowFile’s position in the queue.

Returns:

The position of this FlowFileSummaryDTO.

Return type:

int

property 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

property 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', 'mime_type': 'str', 'penalized': 'bool', 'penalty_expires_in': 'int', 'position': 'int', 'queued_duration': 'int', 'size': 'int', 'uri': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property uuid

Gets the uuid of this FlowFileSummaryDTO. The FlowFile UUID.

Returns:

The uuid of this FlowFileSummaryDTO.

Return type:

str

class nipyapi.nifi.models.FlowRegistryBranchDTO(name=None)

Bases: object

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

FlowRegistryBranchDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(name=None)

FlowRegistryBranchDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'name': 'name'}

property name

Gets the name of this FlowRegistryBranchDTO. The branch name

Returns:

The name of this FlowRegistryBranchDTO.

Return type:

str

swagger_types = {'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryBranchEntity(branch=None)

Bases: object

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

FlowRegistryBranchEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(branch=None)

FlowRegistryBranchEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'branch': 'branch'}

property branch

Gets the branch of this FlowRegistryBranchEntity.

Returns:

The branch of this FlowRegistryBranchEntity.

Return type:

FlowRegistryBranchDTO

swagger_types = {'branch': 'FlowRegistryBranchDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryBranchesEntity(branches=None)

Bases: object

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

FlowRegistryBranchesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(branches=None)

FlowRegistryBranchesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'branches': 'branches'}

property branches

Gets the branches of this FlowRegistryBranchesEntity.

Returns:

The branches of this FlowRegistryBranchesEntity.

Return type:

list[FlowRegistryBranchEntity]

swagger_types = {'branches': 'list[FlowRegistryBranchEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryBucket(created_timestamp=None, description=None, identifier=None, name=None, permissions=None)

Bases: object

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

FlowRegistryBucket - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(created_timestamp=None, description=None, identifier=None, name=None, permissions=None)

FlowRegistryBucket - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'name': 'name', 'permissions': 'permissions'}

property created_timestamp

Gets the created_timestamp of this FlowRegistryBucket.

Returns:

The created_timestamp of this FlowRegistryBucket.

Return type:

int

property description

Gets the description of this FlowRegistryBucket.

Returns:

The description of this FlowRegistryBucket.

Return type:

str

property identifier

Gets the identifier of this FlowRegistryBucket.

Returns:

The identifier of this FlowRegistryBucket.

Return type:

str

property name

Gets the name of this FlowRegistryBucket.

Returns:

The name of this FlowRegistryBucket.

Return type:

str

property permissions

Gets the permissions of this FlowRegistryBucket.

Returns:

The permissions of this FlowRegistryBucket.

Return type:

FlowRegistryPermissions

swagger_types = {'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'name': 'str', 'permissions': 'FlowRegistryPermissions'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

FlowRegistryBucketDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(created=None, description=None, id=None, name=None)

FlowRegistryBucketDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property created

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

Returns:

The created of this FlowRegistryBucketDTO.

Return type:

int

property description

Gets the description of this FlowRegistryBucketDTO. The bucket description

Returns:

The description of this FlowRegistryBucketDTO.

Return type:

str

property id

Gets the id of this FlowRegistryBucketDTO. The bucket identifier

Returns:

The id of this FlowRegistryBucketDTO.

Return type:

str

property name

Gets the name of this FlowRegistryBucketDTO. The bucket name

Returns:

The name of this FlowRegistryBucketDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

FlowRegistryBucketEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket=None, id=None, permissions=None)

FlowRegistryBucketEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bucket

Gets the bucket of this FlowRegistryBucketEntity.

Returns:

The bucket of this FlowRegistryBucketEntity.

Return type:

FlowRegistryBucketDTO

property id

Gets the id of this FlowRegistryBucketEntity.

Returns:

The id of this FlowRegistryBucketEntity.

Return type:

str

property permissions

Gets the permissions of this FlowRegistryBucketEntity.

Returns:

The permissions of this FlowRegistryBucketEntity.

Return type:

PermissionsDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryBucketsEntity(buckets=None)

Bases: object

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

FlowRegistryBucketsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(buckets=None)

FlowRegistryBucketsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'buckets': 'buckets'}

property buckets

Gets the buckets of this FlowRegistryBucketsEntity.

Returns:

The buckets of this FlowRegistryBucketsEntity.

Return type:

list[FlowRegistryBucketEntity]

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryClientDTO(annotation_data=None, bundle=None, deprecated=None, description=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, properties=None, restricted=None, sensitive_dynamic_property_names=None, supports_branching=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None)

Bases: object

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

FlowRegistryClientDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, bundle=None, deprecated=None, description=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, properties=None, restricted=None, sensitive_dynamic_property_names=None, supports_branching=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None)

FlowRegistryClientDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property annotation_data

Gets the annotation_data of this FlowRegistryClientDTO. The annotation data for the registry client. This is how the custom UI relays configuration to the registry client.

Returns:

The annotation_data of this FlowRegistryClientDTO.

Return type:

str

attribute_map = {'annotation_data': 'annotationData', 'bundle': 'bundle', 'deprecated': 'deprecated', 'description': 'description', 'descriptors': 'descriptors', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'properties': 'properties', 'restricted': 'restricted', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'supports_branching': 'supportsBranching', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus'}

property bundle

Gets the bundle of this FlowRegistryClientDTO.

Returns:

The bundle of this FlowRegistryClientDTO.

Return type:

BundleDTO

property deprecated

Gets the deprecated of this FlowRegistryClientDTO. Whether the registry client has been deprecated.

Returns:

The deprecated of this FlowRegistryClientDTO.

Return type:

bool

property description

Gets the description of this FlowRegistryClientDTO. The registry description

Returns:

The description of this FlowRegistryClientDTO.

Return type:

str

property descriptors

Gets the descriptors of this FlowRegistryClientDTO. The descriptors for the registry client properties.

Returns:

The descriptors of this FlowRegistryClientDTO.

Return type:

dict(str, PropertyDescriptorDTO)

property extension_missing

Gets the extension_missing of this FlowRegistryClientDTO. Whether the underlying extension is missing.

Returns:

The extension_missing of this FlowRegistryClientDTO.

Return type:

bool

property id

Gets the id of this FlowRegistryClientDTO. The registry identifier

Returns:

The id of this FlowRegistryClientDTO.

Return type:

str

property multiple_versions_available

Gets the multiple_versions_available of this FlowRegistryClientDTO. Whether the flow registry client has multiple versions available.

Returns:

The multiple_versions_available of this FlowRegistryClientDTO.

Return type:

bool

property name

Gets the name of this FlowRegistryClientDTO. The registry name

Returns:

The name of this FlowRegistryClientDTO.

Return type:

str

property properties

Gets the properties of this FlowRegistryClientDTO. The properties of the registry client.

Returns:

The properties of this FlowRegistryClientDTO.

Return type:

dict(str, str)

property restricted

Gets the restricted of this FlowRegistryClientDTO. Whether the registry client requires elevated privileges.

Returns:

The restricted of this FlowRegistryClientDTO.

Return type:

bool

property sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this FlowRegistryClientDTO. Set of sensitive dynamic property names

Returns:

The sensitive_dynamic_property_names of this FlowRegistryClientDTO.

Return type:

list[str]

property supports_branching

Gets the supports_branching of this FlowRegistryClientDTO. Whether the registry client supports branching.

Returns:

The supports_branching of this FlowRegistryClientDTO.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this FlowRegistryClientDTO. Whether the registry client supports sensitive dynamic properties.

Returns:

The supports_sensitive_dynamic_properties of this FlowRegistryClientDTO.

Return type:

bool

swagger_types = {'annotation_data': 'str', 'bundle': 'BundleDTO', 'deprecated': 'bool', 'description': 'str', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'extension_missing': 'bool', 'id': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'properties': 'dict(str, str)', 'restricted': 'bool', 'sensitive_dynamic_property_names': 'list[str]', 'supports_branching': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this FlowRegistryClientDTO. The type of the registry client.

Returns:

The type of this FlowRegistryClientDTO.

Return type:

str

property validation_errors

Gets the validation_errors of this FlowRegistryClientDTO. Gets the validation errors from the registry client. These validation errors represent the problems with the registry client that must be resolved before it can be used for interacting with the flow registry.

Returns:

The validation_errors of this FlowRegistryClientDTO.

Return type:

list[str]

property validation_status

Gets the validation_status of this FlowRegistryClientDTO. Indicates whether the Registry Client is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Registry Client is valid)

Returns:

The validation_status of this FlowRegistryClientDTO.

Return type:

str

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

Bases: object

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

FlowRegistryClientEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, uri=None)

FlowRegistryClientEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this FlowRegistryClientEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this FlowRegistryClientEntity.

Returns:

The component of this FlowRegistryClientEntity.

Return type:

FlowRegistryClientDTO

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this FlowRegistryClientEntity.

Return type:

bool

property id

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

Returns:

The id of this FlowRegistryClientEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this FlowRegistryClientEntity.

Returns:

The operate_permissions of this FlowRegistryClientEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this FlowRegistryClientEntity.

Returns:

The permissions of this FlowRegistryClientEntity.

Return type:

PermissionsDTO

property position

Gets the position of this FlowRegistryClientEntity.

Returns:

The position of this FlowRegistryClientEntity.

Return type:

PositionDTO

property revision

Gets the revision of this FlowRegistryClientEntity.

Returns:

The revision of this FlowRegistryClientEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this FlowRegistryClientEntity.

Return type:

str

class nipyapi.nifi.models.FlowRegistryClientTypesEntity(flow_registry_client_types=None)

Bases: object

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

FlowRegistryClientTypesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow_registry_client_types=None)

FlowRegistryClientTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_registry_client_types': 'flowRegistryClientTypes'}

property flow_registry_client_types

Gets the flow_registry_client_types of this FlowRegistryClientTypesEntity.

Returns:

The flow_registry_client_types of this FlowRegistryClientTypesEntity.

Return type:

list[DocumentedTypeDTO]

swagger_types = {'flow_registry_client_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryClientsEntity(current_time=None, registries=None)

Bases: object

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

FlowRegistryClientsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, registries=None)

FlowRegistryClientsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'current_time': 'currentTime', 'registries': 'registries'}

property current_time

Gets the current_time of this FlowRegistryClientsEntity. The current time on the system.

Returns:

The current_time of this FlowRegistryClientsEntity.

Return type:

str

property registries

Gets the registries of this FlowRegistryClientsEntity.

Returns:

The registries of this FlowRegistryClientsEntity.

Return type:

list[FlowRegistryClientEntity]

swagger_types = {'current_time': 'str', 'registries': 'list[FlowRegistryClientEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowRegistryPermissions(can_delete=None, can_read=None, can_write=None)

Bases: object

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

FlowRegistryPermissions - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(can_delete=None, can_read=None, can_write=None)

FlowRegistryPermissions - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property can_delete

Gets the can_delete of this FlowRegistryPermissions.

Returns:

The can_delete of this FlowRegistryPermissions.

Return type:

bool

property can_read

Gets the can_read of this FlowRegistryPermissions.

Returns:

The can_read of this FlowRegistryPermissions.

Return type:

bool

property can_write

Gets the can_write of this FlowRegistryPermissions.

Returns:

The can_write of this FlowRegistryPermissions.

Return type:

bool

swagger_types = {'can_delete': 'bool', 'can_read': 'bool', 'can_write': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FlowSnippetDTO(connections=None, controller_services=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None)

Bases: object

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

FlowSnippetDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(connections=None, controller_services=None, funnels=None, input_ports=None, labels=None, output_ports=None, process_groups=None, processors=None, remote_process_groups=None)

FlowSnippetDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property connections

Gets the connections of this FlowSnippetDTO. The connections in this flow snippet.

Returns:

The connections of this FlowSnippetDTO.

Return type:

list[ConnectionDTO]

property 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]

property funnels

Gets the funnels of this FlowSnippetDTO. The funnels in this flow snippet.

Returns:

The funnels of this FlowSnippetDTO.

Return type:

list[FunnelDTO]

property 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]

property labels

Gets the labels of this FlowSnippetDTO. The labels in this flow snippet.

Returns:

The labels of this FlowSnippetDTO.

Return type:

list[LabelDTO]

property 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]

property 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]

property processors

Gets the processors of this FlowSnippetDTO. The processors in this flow snippet.

Returns:

The processors of this FlowSnippetDTO.

Return type:

list[ProcessorDTO]

property remote_process_groups

Gets the remote_process_groups of this FlowSnippetDTO. The remote process groups in this flow snippet.

Returns:

The remote_process_groups of this FlowSnippetDTO.

Return type:

list[RemoteProcessGroupDTO]

swagger_types = {'connections': 'list[ConnectionDTO]', 'controller_services': 'list[ControllerServiceDTO]', 'funnels': 'list[FunnelDTO]', 'input_ports': 'list[PortDTO]', 'labels': 'list[LabelDTO]', 'output_ports': 'list[PortDTO]', 'process_groups': 'list[ProcessGroupDTO]', 'processors': 'list[ProcessorDTO]', 'remote_process_groups': 'list[RemoteProcessGroupDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.FunnelDTO(id=None, parent_group_id=None, position=None, versioned_component_id=None)

Bases: object

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

FunnelDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, parent_group_id=None, position=None, versioned_component_id=None)

FunnelDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

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

Returns:

The id of this FunnelDTO.

Return type:

str

property 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

property position

Gets the position of this FunnelDTO.

Returns:

The position of this FunnelDTO.

Return type:

PositionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

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

Bases: object

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

FunnelEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

FunnelEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this FunnelEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this FunnelEntity.

Returns:

The component of this FunnelEntity.

Return type:

FunnelDTO

property 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

property id

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

Returns:

The id of this FunnelEntity.

Return type:

str

property permissions

Gets the permissions of this FunnelEntity.

Returns:

The permissions of this FunnelEntity.

Return type:

PermissionsDTO

property position

Gets the position of this FunnelEntity.

Returns:

The position of this FunnelEntity.

Return type:

PositionDTO

property revision

Gets the revision of this FunnelEntity.

Returns:

The revision of this FunnelEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this FunnelEntity.

Return type:

str

class nipyapi.nifi.models.FunnelsEntity(funnels=None)

Bases: object

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

FunnelsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(funnels=None)

FunnelsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'funnels': 'funnels'}

property funnels

Gets the funnels of this FunnelsEntity.

Returns:

The funnels of this FunnelsEntity.

Return type:

list[FunnelEntity]

swagger_types = {'funnels': 'list[FunnelEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.GarbageCollectionDTO(collection_count=None, collection_millis=None, collection_time=None, name=None)

Bases: object

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

GarbageCollectionDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(collection_count=None, collection_millis=None, collection_time=None, name=None)

GarbageCollectionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'collection_count': 'collectionCount', 'collection_millis': 'collectionMillis', 'collection_time': 'collectionTime', 'name': 'name'}

property 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

property 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

property 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

property name

Gets the name of this GarbageCollectionDTO. The name of the garbage collector.

Returns:

The name of this GarbageCollectionDTO.

Return type:

str

swagger_types = {'collection_count': 'int', 'collection_millis': 'int', 'collection_time': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.HistoryDTO(actions=None, last_refreshed=None, total=None)

Bases: object

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

HistoryDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(actions=None, last_refreshed=None, total=None)

HistoryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property last_refreshed

Gets the last_refreshed of this HistoryDTO. The timestamp when the report was generated.

Returns:

The last_refreshed of this HistoryDTO.

Return type:

str

swagger_types = {'actions': 'list[ActionEntity]', 'last_refreshed': 'str', 'total': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.HistoryEntity(history=None)

Bases: object

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

HistoryEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(history=None)

HistoryEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'history': 'history'}

property history

Gets the history of this HistoryEntity.

Returns:

The history of this HistoryEntity.

Return type:

HistoryDTO

swagger_types = {'history': 'HistoryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.InputPortsEntity(input_ports=None)

Bases: object

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

InputPortsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(input_ports=None)

InputPortsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'input_ports': 'inputPorts'}

property input_ports

Gets the input_ports of this InputPortsEntity.

Returns:

The input_ports of this InputPortsEntity.

Return type:

list[PortEntity]

swagger_types = {'input_ports': 'list[PortEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.IntegerParameter(integer=None)

Bases: object

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

IntegerParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(integer=None)

IntegerParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'integer': 'integer'}

property integer

Gets the integer of this IntegerParameter.

Returns:

The integer of this IntegerParameter.

Return type:

int

swagger_types = {'integer': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.JmxMetricsResultDTO(attribute_name=None, attribute_value=None, bean_name=None)

Bases: object

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

JmxMetricsResultDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(attribute_name=None, attribute_value=None, bean_name=None)

JmxMetricsResultDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'attribute_name': 'attributeName', 'attribute_value': 'attributeValue', 'bean_name': 'beanName'}

property attribute_name

Gets the attribute_name of this JmxMetricsResultDTO. The attribute name of the metrics bean’s attribute.

Returns:

The attribute_name of this JmxMetricsResultDTO.

Return type:

str

property attribute_value

Gets the attribute_value of this JmxMetricsResultDTO. The attribute value of the the metrics bean’s attribute

Returns:

The attribute_value of this JmxMetricsResultDTO.

Return type:

object

property bean_name

Gets the bean_name of this JmxMetricsResultDTO. The bean name of the metrics bean.

Returns:

The bean_name of this JmxMetricsResultDTO.

Return type:

str

swagger_types = {'attribute_name': 'str', 'attribute_value': 'object', 'bean_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.JmxMetricsResultsEntity(jmx_metrics_results=None)

Bases: object

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

JmxMetricsResultsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(jmx_metrics_results=None)

JmxMetricsResultsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'jmx_metrics_results': 'jmxMetricsResults'}

property jmx_metrics_results

Gets the jmx_metrics_results of this JmxMetricsResultsEntity.

Returns:

The jmx_metrics_results of this JmxMetricsResultsEntity.

Return type:

list[JmxMetricsResultDTO]

swagger_types = {'jmx_metrics_results': 'list[JmxMetricsResultDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.LabelDTO(getz_index=None, height=None, id=None, label=None, parent_group_id=None, position=None, style=None, versioned_component_id=None, width=None)

Bases: object

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

LabelDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(getz_index=None, height=None, id=None, label=None, parent_group_id=None, position=None, style=None, versioned_component_id=None, width=None)

LabelDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'getz_index': 'getzIndex', 'height': 'height', 'id': 'id', 'label': 'label', 'parent_group_id': 'parentGroupId', 'position': 'position', 'style': 'style', 'versioned_component_id': 'versionedComponentId', 'width': 'width'}

property getz_index

Gets the getz_index of this LabelDTO. The z index of the label.

Returns:

The getz_index of this LabelDTO.

Return type:

int

property 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

property id

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

Returns:

The id of this LabelDTO.

Return type:

str

property label

Gets the label of this LabelDTO. The text that appears in the label.

Returns:

The label of this LabelDTO.

Return type:

str

property 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

property position

Gets the position of this LabelDTO.

Returns:

The position of this LabelDTO.

Return type:

PositionDTO

property style

Gets the style of this LabelDTO. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:

The style of this LabelDTO.

Return type:

dict(str, str)

swagger_types = {'getz_index': 'int', 'height': 'float', 'id': 'str', 'label': 'str', 'parent_group_id': 'str', 'position': 'PositionDTO', 'style': 'dict(str, str)', 'versioned_component_id': 'str', 'width': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property 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

class nipyapi.nifi.models.LabelEntity(bulletins=None, component=None, dimensions=None, disconnected_node_acknowledged=None, getz_index=None, id=None, permissions=None, position=None, revision=None, uri=None)

Bases: object

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

LabelEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, dimensions=None, disconnected_node_acknowledged=None, getz_index=None, id=None, permissions=None, position=None, revision=None, uri=None)

LabelEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this LabelEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this LabelEntity.

Returns:

The component of this LabelEntity.

Return type:

LabelDTO

property dimensions

Gets the dimensions of this LabelEntity.

Returns:

The dimensions of this LabelEntity.

Return type:

DimensionsDTO

property 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

property getz_index

Gets the getz_index of this LabelEntity. The z index of the label.

Returns:

The getz_index of this LabelEntity.

Return type:

int

property id

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

Returns:

The id of this LabelEntity.

Return type:

str

property permissions

Gets the permissions of this LabelEntity.

Returns:

The permissions of this LabelEntity.

Return type:

PermissionsDTO

property position

Gets the position of this LabelEntity.

Returns:

The position of this LabelEntity.

Return type:

PositionDTO

property revision

Gets the revision of this LabelEntity.

Returns:

The revision of this LabelEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this LabelEntity.

Return type:

str

class nipyapi.nifi.models.LabelsEntity(labels=None)

Bases: object

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

LabelsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(labels=None)

LabelsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'labels': 'labels'}

property labels

Gets the labels of this LabelsEntity.

Returns:

The labels of this LabelsEntity.

Return type:

list[LabelEntity]

swagger_types = {'labels': 'list[LabelEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.LatestProvenanceEventsDTO(component_id=None, provenance_events=None)

Bases: object

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

LatestProvenanceEventsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_id=None, provenance_events=None)

LatestProvenanceEventsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component_id': 'componentId', 'provenance_events': 'provenanceEvents'}

property component_id

Gets the component_id of this LatestProvenanceEventsDTO.

Returns:

The component_id of this LatestProvenanceEventsDTO.

Return type:

str

property provenance_events

Gets the provenance_events of this LatestProvenanceEventsDTO.

Returns:

The provenance_events of this LatestProvenanceEventsDTO.

Return type:

list[ProvenanceEventDTO]

swagger_types = {'component_id': 'str', 'provenance_events': 'list[ProvenanceEventDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.LatestProvenanceEventsEntity(latest_provenance_events=None)

Bases: object

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

LatestProvenanceEventsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(latest_provenance_events=None)

LatestProvenanceEventsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'latest_provenance_events': 'latestProvenanceEvents'}

property latest_provenance_events

Gets the latest_provenance_events of this LatestProvenanceEventsEntity.

Returns:

The latest_provenance_events of this LatestProvenanceEventsEntity.

Return type:

LatestProvenanceEventsDTO

swagger_types = {'latest_provenance_events': 'LatestProvenanceEventsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.LineageDTO(expiration=None, finished=None, id=None, percent_completed=None, request=None, results=None, submission_time=None, uri=None)

Bases: object

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

LineageDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(expiration=None, finished=None, id=None, percent_completed=None, request=None, results=None, submission_time=None, uri=None)

LineageDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'expiration': 'expiration', 'finished': 'finished', 'id': 'id', 'percent_completed': 'percentCompleted', 'request': 'request', 'results': 'results', 'submission_time': 'submissionTime', 'uri': 'uri'}

property expiration

Gets the expiration of this LineageDTO. When the lineage query will expire.

Returns:

The expiration of this LineageDTO.

Return type:

str

property finished

Gets the finished of this LineageDTO. Whether the lineage query has finished.

Returns:

The finished of this LineageDTO.

Return type:

bool

property id

Gets the id of this LineageDTO. The id of this lineage query.

Returns:

The id of this LineageDTO.

Return type:

str

property 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

property request

Gets the request of this LineageDTO.

Returns:

The request of this LineageDTO.

Return type:

LineageRequestDTO

property results

Gets the results of this LineageDTO.

Returns:

The results of this LineageDTO.

Return type:

LineageResultsDTO

property submission_time

Gets the submission_time of this LineageDTO. When the lineage query was submitted.

Returns:

The submission_time of this LineageDTO.

Return type:

str

swagger_types = {'expiration': 'str', 'finished': 'bool', 'id': 'str', 'percent_completed': 'int', 'request': 'LineageRequestDTO', 'results': 'LineageResultsDTO', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.LineageEntity(lineage=None)

Bases: object

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

LineageEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(lineage=None)

LineageEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'lineage': 'lineage'}

property lineage

Gets the lineage of this LineageEntity.

Returns:

The lineage of this LineageEntity.

Return type:

LineageDTO

swagger_types = {'lineage': 'LineageDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.LineageRequestDTO(cluster_node_id=None, event_id=None, lineage_request_type=None, uuid=None)

Bases: object

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

LineageRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cluster_node_id=None, event_id=None, lineage_request_type=None, uuid=None)

LineageRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cluster_node_id': 'clusterNodeId', 'event_id': 'eventId', 'lineage_request_type': 'lineageRequestType', 'uuid': 'uuid'}

property 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

property 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

property lineage_request_type

Gets the lineage_request_type of this LineageRequestDTO. The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.

Returns:

The lineage_request_type of this LineageRequestDTO.

Return type:

str

swagger_types = {'cluster_node_id': 'str', 'event_id': 'int', 'lineage_request_type': 'str', 'uuid': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.LineageResultsDTO(errors=None, links=None, nodes=None)

Bases: object

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

LineageResultsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(errors=None, links=None, nodes=None)

LineageResultsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'errors': 'errors', 'links': 'links', 'nodes': 'nodes'}

property 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]

property links

Gets the links of this LineageResultsDTO. The links between the nodes in the lineage.

Returns:

The links of this LineageResultsDTO.

Return type:

list[ProvenanceLinkDTO]

property nodes

Gets the nodes of this LineageResultsDTO. The nodes in the lineage.

Returns:

The nodes of this LineageResultsDTO.

Return type:

list[ProvenanceNodeDTO]

swagger_types = {'errors': 'list[str]', 'links': 'list[ProvenanceLinkDTO]', 'nodes': 'list[ProvenanceNodeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ListingRequestDTO(destination_running=None, failure_reason=None, finished=None, flow_file_summaries=None, id=None, last_updated=None, max_results=None, percent_completed=None, queue_size=None, source_running=None, state=None, submission_time=None, uri=None)

Bases: object

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

ListingRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(destination_running=None, failure_reason=None, finished=None, flow_file_summaries=None, id=None, last_updated=None, max_results=None, percent_completed=None, queue_size=None, source_running=None, state=None, submission_time=None, uri=None)

ListingRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property finished

Gets the finished of this ListingRequestDTO. Whether the query has finished.

Returns:

The finished of this ListingRequestDTO.

Return type:

bool

property 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]

property id

Gets the id of this ListingRequestDTO. The id for this listing request.

Returns:

The id of this ListingRequestDTO.

Return type:

str

property 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

property 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

property percent_completed

Gets the percent_completed of this ListingRequestDTO. The current percent complete.

Returns:

The percent_completed of this ListingRequestDTO.

Return type:

int

property queue_size

Gets the queue_size of this ListingRequestDTO.

Returns:

The queue_size of this ListingRequestDTO.

Return type:

QueueSizeDTO

property 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

property state

Gets the state of this ListingRequestDTO. The current state of the listing request.

Returns:

The state of this ListingRequestDTO.

Return type:

str

property submission_time

Gets the submission_time of this ListingRequestDTO. The timestamp when the query was submitted.

Returns:

The submission_time of this ListingRequestDTO.

Return type:

str

swagger_types = {'destination_running': 'bool', 'failure_reason': 'str', 'finished': 'bool', 'flow_file_summaries': 'list[FlowFileSummaryDTO]', 'id': 'str', 'last_updated': 'str', 'max_results': 'int', 'percent_completed': 'int', 'queue_size': 'QueueSizeDTO', 'source_running': 'bool', 'state': 'str', 'submission_time': 'str', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ListingRequestEntity(listing_request=None)

Bases: object

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

ListingRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(listing_request=None)

ListingRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'listing_request': 'listingRequest'}

property listing_request

Gets the listing_request of this ListingRequestEntity.

Returns:

The listing_request of this ListingRequestEntity.

Return type:

ListingRequestDTO

swagger_types = {'listing_request': 'ListingRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.LongParameter(long=None)

Bases: object

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

LongParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(long=None)

LongParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'long': 'long'}

property long

Gets the long of this LongParameter.

Returns:

The long of this LongParameter.

Return type:

int

swagger_types = {'long': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.MultiProcessorUseCase(configurations=None, description=None, keywords=None, notes=None)

Bases: object

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

MultiProcessorUseCase - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(configurations=None, description=None, keywords=None, notes=None)

MultiProcessorUseCase - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'configurations': 'configurations', 'description': 'description', 'keywords': 'keywords', 'notes': 'notes'}

property configurations

Gets the configurations of this MultiProcessorUseCase. A description of how to configure the Processor to perform the task described in the use case

Returns:

The configurations of this MultiProcessorUseCase.

Return type:

list[ProcessorConfiguration]

property description

Gets the description of this MultiProcessorUseCase. A description of the use case

Returns:

The description of this MultiProcessorUseCase.

Return type:

str

property keywords

Gets the keywords of this MultiProcessorUseCase. Keywords that pertain to the use csae

Returns:

The keywords of this MultiProcessorUseCase.

Return type:

list[str]

property notes

Gets the notes of this MultiProcessorUseCase. Any pertinent notes about the use case

Returns:

The notes of this MultiProcessorUseCase.

Return type:

str

swagger_types = {'configurations': 'list[ProcessorConfiguration]', 'description': 'str', 'keywords': 'list[str]', 'notes': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

NarCoordinateDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact=None, group=None, version=None)

NarCoordinateDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact

Gets the artifact of this NarCoordinateDTO. The artifact id of the NAR.

Returns:

The artifact of this NarCoordinateDTO.

Return type:

str

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

property group

Gets the group of this NarCoordinateDTO. The group of the NAR.

Returns:

The group of this NarCoordinateDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this NarCoordinateDTO. The version of the NAR.

Returns:

The version of this NarCoordinateDTO.

Return type:

str

class nipyapi.nifi.models.NarDetailsEntity(controller_service_types=None, dependent_coordinates=None, flow_analysis_rule_types=None, flow_registry_client_types=None, nar_summary=None, parameter_provider_types=None, processor_types=None, reporting_task_types=None)

Bases: object

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

NarDetailsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_service_types=None, dependent_coordinates=None, flow_analysis_rule_types=None, flow_registry_client_types=None, nar_summary=None, parameter_provider_types=None, processor_types=None, reporting_task_types=None)

NarDetailsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_service_types': 'controllerServiceTypes', 'dependent_coordinates': 'dependentCoordinates', 'flow_analysis_rule_types': 'flowAnalysisRuleTypes', 'flow_registry_client_types': 'flowRegistryClientTypes', 'nar_summary': 'narSummary', 'parameter_provider_types': 'parameterProviderTypes', 'processor_types': 'processorTypes', 'reporting_task_types': 'reportingTaskTypes'}

property controller_service_types

Gets the controller_service_types of this NarDetailsEntity. The ControllerService types contained in the NAR

Returns:

The controller_service_types of this NarDetailsEntity.

Return type:

list[DocumentedTypeDTO]

property dependent_coordinates

Gets the dependent_coordinates of this NarDetailsEntity. The coordinates of NARs that depend on this NAR

Returns:

The dependent_coordinates of this NarDetailsEntity.

Return type:

list[NarCoordinateDTO]

property flow_analysis_rule_types

Gets the flow_analysis_rule_types of this NarDetailsEntity. The FlowAnalysisRule types contained in the NAR

Returns:

The flow_analysis_rule_types of this NarDetailsEntity.

Return type:

list[DocumentedTypeDTO]

property flow_registry_client_types

Gets the flow_registry_client_types of this NarDetailsEntity. The FlowRegistryClient types contained in the NAR

Returns:

The flow_registry_client_types of this NarDetailsEntity.

Return type:

list[DocumentedTypeDTO]

property nar_summary

Gets the nar_summary of this NarDetailsEntity.

Returns:

The nar_summary of this NarDetailsEntity.

Return type:

NarSummaryDTO

property parameter_provider_types

Gets the parameter_provider_types of this NarDetailsEntity. The ParameterProvider types contained in the NAR

Returns:

The parameter_provider_types of this NarDetailsEntity.

Return type:

list[DocumentedTypeDTO]

property processor_types

Gets the processor_types of this NarDetailsEntity. The Processor types contained in the NAR

Returns:

The processor_types of this NarDetailsEntity.

Return type:

list[DocumentedTypeDTO]

property reporting_task_types

Gets the reporting_task_types of this NarDetailsEntity. The ReportingTask types contained in the NAR

Returns:

The reporting_task_types of this NarDetailsEntity.

Return type:

list[DocumentedTypeDTO]

swagger_types = {'controller_service_types': 'list[DocumentedTypeDTO]', 'dependent_coordinates': 'list[NarCoordinateDTO]', 'flow_analysis_rule_types': 'list[DocumentedTypeDTO]', 'flow_registry_client_types': 'list[DocumentedTypeDTO]', 'nar_summary': 'NarSummaryDTO', 'parameter_provider_types': 'list[DocumentedTypeDTO]', 'processor_types': 'list[DocumentedTypeDTO]', 'reporting_task_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NarSummariesEntity(current_time=None, nar_summaries=None)

Bases: object

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

NarSummariesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, nar_summaries=None)

NarSummariesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'current_time': 'currentTime', 'nar_summaries': 'narSummaries'}

property current_time

Gets the current_time of this NarSummariesEntity. The current time on the system.

Returns:

The current_time of this NarSummariesEntity.

Return type:

str

property nar_summaries

Gets the nar_summaries of this NarSummariesEntity. The NAR summaries

Returns:

The nar_summaries of this NarSummariesEntity.

Return type:

list[NarSummaryEntity]

swagger_types = {'current_time': 'str', 'nar_summaries': 'list[NarSummaryEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NarSummaryDTO(build_time=None, coordinate=None, created_by=None, dependency_coordinate=None, digest=None, extension_count=None, failure_message=None, identifier=None, install_complete=None, source_identifier=None, source_type=None, state=None)

Bases: object

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

NarSummaryDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(build_time=None, coordinate=None, created_by=None, dependency_coordinate=None, digest=None, extension_count=None, failure_message=None, identifier=None, install_complete=None, source_identifier=None, source_type=None, state=None)

NarSummaryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'build_time': 'buildTime', 'coordinate': 'coordinate', 'created_by': 'createdBy', 'dependency_coordinate': 'dependencyCoordinate', 'digest': 'digest', 'extension_count': 'extensionCount', 'failure_message': 'failureMessage', 'identifier': 'identifier', 'install_complete': 'installComplete', 'source_identifier': 'sourceIdentifier', 'source_type': 'sourceType', 'state': 'state'}

property build_time

Gets the build_time of this NarSummaryDTO. The time the NAR was built according to it’s MANIFEST

Returns:

The build_time of this NarSummaryDTO.

Return type:

str

property coordinate

Gets the coordinate of this NarSummaryDTO.

Returns:

The coordinate of this NarSummaryDTO.

Return type:

NarCoordinateDTO

property created_by

Gets the created_by of this NarSummaryDTO. The plugin that created the NAR according to it’s MANIFEST

Returns:

The created_by of this NarSummaryDTO.

Return type:

str

property dependency_coordinate

Gets the dependency_coordinate of this NarSummaryDTO.

Returns:

The dependency_coordinate of this NarSummaryDTO.

Return type:

NarCoordinateDTO

property digest

Gets the digest of this NarSummaryDTO. The hex digest of the NAR contents

Returns:

The digest of this NarSummaryDTO.

Return type:

str

property extension_count

Gets the extension_count of this NarSummaryDTO. The number of extensions contained in this NAR

Returns:

The extension_count of this NarSummaryDTO.

Return type:

int

property failure_message

Gets the failure_message of this NarSummaryDTO. Information about why the installation failed, only populated when the state is failed

Returns:

The failure_message of this NarSummaryDTO.

Return type:

str

property identifier

Gets the identifier of this NarSummaryDTO. The identifier of the NAR.

Returns:

The identifier of this NarSummaryDTO.

Return type:

str

property install_complete

Gets the install_complete of this NarSummaryDTO. Indicates if the install task has completed

Returns:

The install_complete of this NarSummaryDTO.

Return type:

bool

property source_identifier

Gets the source_identifier of this NarSummaryDTO. The identifier of the source of this NAR

Returns:

The source_identifier of this NarSummaryDTO.

Return type:

str

property source_type

Gets the source_type of this NarSummaryDTO. The source of this NAR

Returns:

The source_type of this NarSummaryDTO.

Return type:

str

property state

Gets the state of this NarSummaryDTO. The state of the NAR (i.e. Installed, or not)

Returns:

The state of this NarSummaryDTO.

Return type:

str

swagger_types = {'build_time': 'str', 'coordinate': 'NarCoordinateDTO', 'created_by': 'str', 'dependency_coordinate': 'NarCoordinateDTO', 'digest': 'str', 'extension_count': 'int', 'failure_message': 'str', 'identifier': 'str', 'install_complete': 'bool', 'source_identifier': 'str', 'source_type': 'str', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NarSummaryEntity(nar_summary=None)

Bases: object

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

NarSummaryEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(nar_summary=None)

NarSummaryEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'nar_summary': 'narSummary'}

property nar_summary

Gets the nar_summary of this NarSummaryEntity.

Returns:

The nar_summary of this NarSummaryEntity.

Return type:

NarSummaryDTO

swagger_types = {'nar_summary': 'NarSummaryDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeConnectionStatisticsSnapshotDTO(address=None, api_port=None, node_id=None, statistics_snapshot=None)

Bases: object

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

NodeConnectionStatisticsSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, statistics_snapshot=None)

NodeConnectionStatisticsSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeConnectionStatisticsSnapshotDTO.

Return type:

str

property api_port

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

Returns:

The api_port of this NodeConnectionStatisticsSnapshotDTO.

Return type:

int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'statistics_snapshot': 'statisticsSnapshot'}

property node_id

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

Returns:

The node_id of this NodeConnectionStatisticsSnapshotDTO.

Return type:

str

property statistics_snapshot

Gets the statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO.

Returns:

The statistics_snapshot of this NodeConnectionStatisticsSnapshotDTO.

Return type:

ConnectionStatisticsSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'statistics_snapshot': 'ConnectionStatisticsSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeConnectionStatusSnapshotDTO(address=None, api_port=None, node_id=None, status_snapshot=None)

Bases: object

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

NodeConnectionStatusSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, status_snapshot=None)

NodeConnectionStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeConnectionStatusSnapshotDTO.

Return type:

str

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

property 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

property status_snapshot

Gets the status_snapshot of this NodeConnectionStatusSnapshotDTO.

Returns:

The status_snapshot of this NodeConnectionStatusSnapshotDTO.

Return type:

ConnectionStatusSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'status_snapshot': 'ConnectionStatusSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeCountersSnapshotDTO(address=None, api_port=None, node_id=None, snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, snapshot=None)

NodeCountersSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeCountersSnapshotDTO.

Return type:

str

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

property 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

property snapshot

Gets the snapshot of this NodeCountersSnapshotDTO.

Returns:

The snapshot of this NodeCountersSnapshotDTO.

Return type:

CountersSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'CountersSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeDTO(active_thread_count=None, address=None, api_port=None, bytes_queued=None, connection_requested=None, events=None, flow_file_bytes=None, flow_files_queued=None, heartbeat=None, node_id=None, node_start_time=None, queued=None, roles=None, status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, address=None, api_port=None, bytes_queued=None, connection_requested=None, events=None, flow_file_bytes=None, flow_files_queued=None, heartbeat=None, node_id=None, node_start_time=None, queued=None, roles=None, status=None)

NodeDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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

property address

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

Returns:

The address of this NodeDTO.

Return type:

str

property 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', 'bytes_queued': 'bytesQueued', 'connection_requested': 'connectionRequested', 'events': 'events', 'flow_file_bytes': 'flowFileBytes', 'flow_files_queued': 'flowFilesQueued', 'heartbeat': 'heartbeat', 'node_id': 'nodeId', 'node_start_time': 'nodeStartTime', 'queued': 'queued', 'roles': 'roles', 'status': 'status'}

property bytes_queued

Gets the bytes_queued of this NodeDTO. The total size of all FlowFiles that are queued up on the node

Returns:

The bytes_queued of this NodeDTO.

Return type:

int

property 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

property events

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

Returns:

The events of this NodeDTO.

Return type:

list[NodeEventDTO]

property flow_file_bytes

Gets the flow_file_bytes of this NodeDTO.

Returns:

The flow_file_bytes of this NodeDTO.

Return type:

int

property flow_files_queued

Gets the flow_files_queued of this NodeDTO. The number of FlowFiles that are queued up on the node

Returns:

The flow_files_queued of this NodeDTO.

Return type:

int

property heartbeat

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

Returns:

The heartbeat of this NodeDTO.

Return type:

str

property node_id

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

Returns:

The node_id of this NodeDTO.

Return type:

str

property 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

property queued

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

Returns:

The queued of this NodeDTO.

Return type:

str

property roles

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

Returns:

The roles of this NodeDTO.

Return type:

list[str]

property 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', 'bytes_queued': 'int', 'connection_requested': 'str', 'events': 'list[NodeEventDTO]', 'flow_file_bytes': 'int', 'flow_files_queued': 'int', 'heartbeat': 'str', 'node_id': 'str', 'node_start_time': 'str', 'queued': 'str', 'roles': 'list[str]', 'status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeEntity(node=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(node=None)

NodeEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'node': 'node'}

property node

Gets the node of this NodeEntity.

Returns:

The node of this NodeEntity.

Return type:

NodeDTO

swagger_types = {'node': 'NodeDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeEventDTO(category=None, message=None, timestamp=None)

Bases: object

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

NodeEventDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(category=None, message=None, timestamp=None)

NodeEventDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property category

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

Returns:

The category of this NodeEventDTO.

Return type:

str

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

property timestamp

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

Returns:

The timestamp of this NodeEventDTO.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodePortStatusSnapshotDTO(address=None, api_port=None, node_id=None, status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, status_snapshot=None)

NodePortStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodePortStatusSnapshotDTO.

Return type:

str

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

property 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

property status_snapshot

Gets the status_snapshot of this NodePortStatusSnapshotDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeProcessGroupStatusSnapshotDTO(address=None, api_port=None, node_id=None, status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, status_snapshot=None)

NodeProcessGroupStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeProcessGroupStatusSnapshotDTO.

Return type:

str

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

property 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

property status_snapshot

Gets the status_snapshot of this NodeProcessGroupStatusSnapshotDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeProcessorStatusSnapshotDTO(address=None, api_port=None, node_id=None, status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, status_snapshot=None)

NodeProcessorStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeProcessorStatusSnapshotDTO.

Return type:

str

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

property 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

property status_snapshot

Gets the status_snapshot of this NodeProcessorStatusSnapshotDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeRemoteProcessGroupStatusSnapshotDTO(address=None, api_port=None, node_id=None, status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, status_snapshot=None)

NodeRemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeRemoteProcessGroupStatusSnapshotDTO.

Return type:

str

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

property 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

property status_snapshot

Gets the status_snapshot of this NodeRemoteProcessGroupStatusSnapshotDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeReplayLastEventSnapshotDTO(address=None, api_port=None, node_id=None, snapshot=None)

Bases: object

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

NodeReplayLastEventSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, snapshot=None)

NodeReplayLastEventSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeReplayLastEventSnapshotDTO.

Return type:

str

property api_port

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

Returns:

The api_port of this NodeReplayLastEventSnapshotDTO.

Return type:

int

attribute_map = {'address': 'address', 'api_port': 'apiPort', 'node_id': 'nodeId', 'snapshot': 'snapshot'}

property node_id

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

Returns:

The node_id of this NodeReplayLastEventSnapshotDTO.

Return type:

str

property snapshot

Gets the snapshot of this NodeReplayLastEventSnapshotDTO.

Returns:

The snapshot of this NodeReplayLastEventSnapshotDTO.

Return type:

ReplayLastEventSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'ReplayLastEventSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeSearchResultDTO(address=None, id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, id=None)

NodeSearchResultDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeStatusSnapshotsDTO(address=None, api_port=None, node_id=None, status_snapshots=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, status_snapshots=None)

NodeStatusSnapshotsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeStatusSnapshotsDTO.

Return type:

str

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

property node_id

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

Returns:

The node_id of this NodeStatusSnapshotsDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.NodeSystemDiagnosticsSnapshotDTO(address=None, api_port=None, node_id=None, snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(address=None, api_port=None, node_id=None, snapshot=None)

NodeSystemDiagnosticsSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property address

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

Returns:

The address of this NodeSystemDiagnosticsSnapshotDTO.

Return type:

str

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

property 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

property snapshot

Gets the snapshot of this NodeSystemDiagnosticsSnapshotDTO.

Returns:

The snapshot of this NodeSystemDiagnosticsSnapshotDTO.

Return type:

SystemDiagnosticsSnapshotDTO

swagger_types = {'address': 'str', 'api_port': 'int', 'node_id': 'str', 'snapshot': 'SystemDiagnosticsSnapshotDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.OutputPortsEntity(output_ports=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(output_ports=None)

OutputPortsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'output_ports': 'outputPorts'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextDTO(bound_process_groups=None, description=None, id=None, inherited_parameter_contexts=None, name=None, parameter_provider_configuration=None, parameters=None)

Bases: object

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

ParameterContextDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bound_process_groups=None, description=None, id=None, inherited_parameter_contexts=None, name=None, parameter_provider_configuration=None, parameters=None)

ParameterContextDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bound_process_groups': 'boundProcessGroups', 'description': 'description', 'id': 'id', 'inherited_parameter_contexts': 'inheritedParameterContexts', 'name': 'name', 'parameter_provider_configuration': 'parameterProviderConfiguration', 'parameters': 'parameters'}

property bound_process_groups

Gets the bound_process_groups of this ParameterContextDTO. The Process Groups that are bound to this Parameter Context

Returns:

The bound_process_groups of this ParameterContextDTO.

Return type:

list[ProcessGroupEntity]

property description

Gets the description of this ParameterContextDTO. The Description of the Parameter Context.

Returns:

The description of this ParameterContextDTO.

Return type:

str

property id

Gets the id of this ParameterContextDTO. The ID the Parameter Context.

Returns:

The id of this ParameterContextDTO.

Return type:

str

property inherited_parameter_contexts

Gets the inherited_parameter_contexts of this ParameterContextDTO. A list of references of Parameter Contexts from which this one inherits parameters

Returns:

The inherited_parameter_contexts of this ParameterContextDTO.

Return type:

list[ParameterContextReferenceEntity]

property name

Gets the name of this ParameterContextDTO. The Name of the Parameter Context.

Returns:

The name of this ParameterContextDTO.

Return type:

str

property parameter_provider_configuration

Gets the parameter_provider_configuration of this ParameterContextDTO.

Returns:

The parameter_provider_configuration of this ParameterContextDTO.

Return type:

ParameterProviderConfigurationEntity

property parameters

Gets the parameters of this ParameterContextDTO. The Parameters for the Parameter Context

Returns:

The parameters of this ParameterContextDTO.

Return type:

list[ParameterEntity]

swagger_types = {'bound_process_groups': 'list[ProcessGroupEntity]', 'description': 'str', 'id': 'str', 'inherited_parameter_contexts': 'list[ParameterContextReferenceEntity]', 'name': 'str', 'parameter_provider_configuration': 'ParameterProviderConfigurationEntity', 'parameters': 'list[ParameterEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ParameterContextEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

ParameterContextEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ParameterContextEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ParameterContextEntity.

Returns:

The component of this ParameterContextEntity.

Return type:

ParameterContextDTO

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ParameterContextEntity.

Return type:

bool

property id

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

Returns:

The id of this ParameterContextEntity.

Return type:

str

property permissions

Gets the permissions of this ParameterContextEntity.

Returns:

The permissions of this ParameterContextEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ParameterContextEntity.

Returns:

The position of this ParameterContextEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ParameterContextEntity.

Returns:

The revision of this ParameterContextEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ParameterContextEntity.

Return type:

str

class nipyapi.nifi.models.ParameterContextReferenceDTO(id=None, name=None)

Bases: object

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

ParameterContextReferenceDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None)

ParameterContextReferenceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

Gets the id of this ParameterContextReferenceDTO. The ID of the Parameter Context

Returns:

The id of this ParameterContextReferenceDTO.

Return type:

str

property name

Gets the name of this ParameterContextReferenceDTO. The name of the Parameter Context

Returns:

The name of this ParameterContextReferenceDTO.

Return type:

str

swagger_types = {'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextReferenceEntity(component=None, id=None, permissions=None)

Bases: object

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

ParameterContextReferenceEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component=None, id=None, permissions=None)

ParameterContextReferenceEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component

Gets the component of this ParameterContextReferenceEntity.

Returns:

The component of this ParameterContextReferenceEntity.

Return type:

ParameterContextReferenceDTO

property id

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

Returns:

The id of this ParameterContextReferenceEntity.

Return type:

str

property permissions

Gets the permissions of this ParameterContextReferenceEntity.

Returns:

The permissions of this ParameterContextReferenceEntity.

Return type:

PermissionsDTO

swagger_types = {'component': 'ParameterContextReferenceDTO', 'id': 'str', 'permissions': 'PermissionsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextUpdateEntity(parameter_context=None, parameter_context_revision=None, referencing_components=None)

Bases: object

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

ParameterContextUpdateEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(parameter_context=None, parameter_context_revision=None, referencing_components=None)

ParameterContextUpdateEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'parameter_context': 'parameterContext', 'parameter_context_revision': 'parameterContextRevision', 'referencing_components': 'referencingComponents'}

property parameter_context

Gets the parameter_context of this ParameterContextUpdateEntity.

Returns:

The parameter_context of this ParameterContextUpdateEntity.

Return type:

ParameterContextDTO

property parameter_context_revision

Gets the parameter_context_revision of this ParameterContextUpdateEntity.

Returns:

The parameter_context_revision of this ParameterContextUpdateEntity.

Return type:

RevisionDTO

property referencing_components

Gets the referencing_components of this ParameterContextUpdateEntity. The components that are referenced by the update.

Returns:

The referencing_components of this ParameterContextUpdateEntity.

Return type:

list[AffectedComponentEntity]

swagger_types = {'parameter_context': 'ParameterContextDTO', 'parameter_context_revision': 'RevisionDTO', 'referencing_components': 'list[AffectedComponentEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextUpdateRequestDTO(complete=None, failure_reason=None, last_updated=None, parameter_context=None, percent_completed=None, referencing_components=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None)

Bases: object

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

ParameterContextUpdateRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, failure_reason=None, last_updated=None, parameter_context=None, percent_completed=None, referencing_components=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None)

ParameterContextUpdateRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'parameter_context': 'parameterContext', 'percent_completed': 'percentCompleted', 'referencing_components': 'referencingComponents', 'request_id': 'requestId', 'state': 'state', 'submission_time': 'submissionTime', 'update_steps': 'updateSteps', 'uri': 'uri'}

property complete

Gets the complete of this ParameterContextUpdateRequestDTO. Whether or not the request is completed

Returns:

The complete of this ParameterContextUpdateRequestDTO.

Return type:

bool

property failure_reason

Gets the failure_reason of this ParameterContextUpdateRequestDTO. The reason for the request failing, or null if the request has not failed

Returns:

The failure_reason of this ParameterContextUpdateRequestDTO.

Return type:

str

property last_updated

Gets the last_updated of this ParameterContextUpdateRequestDTO. The timestamp of when the request was last updated

Returns:

The last_updated of this ParameterContextUpdateRequestDTO.

Return type:

datetime

property parameter_context

Gets the parameter_context of this ParameterContextUpdateRequestDTO.

Returns:

The parameter_context of this ParameterContextUpdateRequestDTO.

Return type:

ParameterContextDTO

property percent_completed

Gets the percent_completed of this ParameterContextUpdateRequestDTO. A value between 0 and 100 (inclusive) indicating how close the request is to completion

Returns:

The percent_completed of this ParameterContextUpdateRequestDTO.

Return type:

int

property referencing_components

Gets the referencing_components of this ParameterContextUpdateRequestDTO. The components that are referenced by the update.

Returns:

The referencing_components of this ParameterContextUpdateRequestDTO.

Return type:

list[AffectedComponentEntity]

property request_id

Gets the request_id of this ParameterContextUpdateRequestDTO. The ID of the request

Returns:

The request_id of this ParameterContextUpdateRequestDTO.

Return type:

str

property state

Gets the state of this ParameterContextUpdateRequestDTO. A description of the current state of the request

Returns:

The state of this ParameterContextUpdateRequestDTO.

Return type:

str

property submission_time

Gets the submission_time of this ParameterContextUpdateRequestDTO. The timestamp of when the request was submitted

Returns:

The submission_time of this ParameterContextUpdateRequestDTO.

Return type:

datetime

swagger_types = {'complete': 'bool', 'failure_reason': 'str', 'last_updated': 'datetime', 'parameter_context': 'ParameterContextDTO', 'percent_completed': 'int', 'referencing_components': 'list[AffectedComponentEntity]', 'request_id': 'str', 'state': 'str', 'submission_time': 'datetime', 'update_steps': 'list[ParameterContextUpdateStepDTO]', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property update_steps

Gets the update_steps of this ParameterContextUpdateRequestDTO. The steps that are required in order to complete the request, along with the status of each

Returns:

The update_steps of this ParameterContextUpdateRequestDTO.

Return type:

list[ParameterContextUpdateStepDTO]

property uri

Gets the uri of this ParameterContextUpdateRequestDTO. The URI for the request

Returns:

The uri of this ParameterContextUpdateRequestDTO.

Return type:

str

class nipyapi.nifi.models.ParameterContextUpdateRequestEntity(parameter_context_revision=None, request=None)

Bases: object

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

ParameterContextUpdateRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(parameter_context_revision=None, request=None)

ParameterContextUpdateRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'parameter_context_revision': 'parameterContextRevision', 'request': 'request'}

property parameter_context_revision

Gets the parameter_context_revision of this ParameterContextUpdateRequestEntity.

Returns:

The parameter_context_revision of this ParameterContextUpdateRequestEntity.

Return type:

RevisionDTO

property request

Gets the request of this ParameterContextUpdateRequestEntity.

Returns:

The request of this ParameterContextUpdateRequestEntity.

Return type:

ParameterContextUpdateRequestDTO

swagger_types = {'parameter_context_revision': 'RevisionDTO', 'request': 'ParameterContextUpdateRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextUpdateStepDTO(complete=None, description=None, failure_reason=None)

Bases: object

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

ParameterContextUpdateStepDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, description=None, failure_reason=None)

ParameterContextUpdateStepDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'description': 'description', 'failure_reason': 'failureReason'}

property complete

Gets the complete of this ParameterContextUpdateStepDTO. Whether or not this step has completed

Returns:

The complete of this ParameterContextUpdateStepDTO.

Return type:

bool

property description

Gets the description of this ParameterContextUpdateStepDTO. Explanation of what happens in this step

Returns:

The description of this ParameterContextUpdateStepDTO.

Return type:

str

property failure_reason

Gets the failure_reason of this ParameterContextUpdateStepDTO. An explanation of why this step failed, or null if this step did not fail

Returns:

The failure_reason of this ParameterContextUpdateStepDTO.

Return type:

str

swagger_types = {'complete': 'bool', 'description': 'str', 'failure_reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextValidationRequestDTO(complete=None, component_validation_results=None, failure_reason=None, last_updated=None, parameter_context=None, percent_completed=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None)

Bases: object

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

ParameterContextValidationRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, component_validation_results=None, failure_reason=None, last_updated=None, parameter_context=None, percent_completed=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None)

ParameterContextValidationRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'component_validation_results': 'componentValidationResults', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'parameter_context': 'parameterContext', 'percent_completed': 'percentCompleted', 'request_id': 'requestId', 'state': 'state', 'submission_time': 'submissionTime', 'update_steps': 'updateSteps', 'uri': 'uri'}

property complete

Gets the complete of this ParameterContextValidationRequestDTO. Whether or not the request is completed

Returns:

The complete of this ParameterContextValidationRequestDTO.

Return type:

bool

property component_validation_results

Gets the component_validation_results of this ParameterContextValidationRequestDTO.

Returns:

The component_validation_results of this ParameterContextValidationRequestDTO.

Return type:

ComponentValidationResultsEntity

property failure_reason

Gets the failure_reason of this ParameterContextValidationRequestDTO. The reason for the request failing, or null if the request has not failed

Returns:

The failure_reason of this ParameterContextValidationRequestDTO.

Return type:

str

property last_updated

Gets the last_updated of this ParameterContextValidationRequestDTO. The timestamp of when the request was last updated

Returns:

The last_updated of this ParameterContextValidationRequestDTO.

Return type:

datetime

property parameter_context

Gets the parameter_context of this ParameterContextValidationRequestDTO.

Returns:

The parameter_context of this ParameterContextValidationRequestDTO.

Return type:

ParameterContextDTO

property percent_completed

Gets the percent_completed of this ParameterContextValidationRequestDTO. A value between 0 and 100 (inclusive) indicating how close the request is to completion

Returns:

The percent_completed of this ParameterContextValidationRequestDTO.

Return type:

int

property request_id

Gets the request_id of this ParameterContextValidationRequestDTO. The ID of the request

Returns:

The request_id of this ParameterContextValidationRequestDTO.

Return type:

str

property state

Gets the state of this ParameterContextValidationRequestDTO. A description of the current state of the request

Returns:

The state of this ParameterContextValidationRequestDTO.

Return type:

str

property submission_time

Gets the submission_time of this ParameterContextValidationRequestDTO. The timestamp of when the request was submitted

Returns:

The submission_time of this ParameterContextValidationRequestDTO.

Return type:

datetime

swagger_types = {'complete': 'bool', 'component_validation_results': 'ComponentValidationResultsEntity', 'failure_reason': 'str', 'last_updated': 'datetime', 'parameter_context': 'ParameterContextDTO', 'percent_completed': 'int', 'request_id': 'str', 'state': 'str', 'submission_time': 'datetime', 'update_steps': 'list[ParameterContextValidationStepDTO]', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property update_steps

Gets the update_steps of this ParameterContextValidationRequestDTO. The steps that are required in order to complete the request, along with the status of each

Returns:

The update_steps of this ParameterContextValidationRequestDTO.

Return type:

list[ParameterContextValidationStepDTO]

property uri

Gets the uri of this ParameterContextValidationRequestDTO. The URI for the request

Returns:

The uri of this ParameterContextValidationRequestDTO.

Return type:

str

class nipyapi.nifi.models.ParameterContextValidationRequestEntity(disconnected_node_acknowledged=None, request=None)

Bases: object

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

ParameterContextValidationRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, request=None)

ParameterContextValidationRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'request': 'request'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ParameterContextValidationRequestEntity.

Return type:

bool

property request

Gets the request of this ParameterContextValidationRequestEntity.

Returns:

The request of this ParameterContextValidationRequestEntity.

Return type:

ParameterContextValidationRequestDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'request': 'ParameterContextValidationRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextValidationStepDTO(complete=None, description=None, failure_reason=None)

Bases: object

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

ParameterContextValidationStepDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, description=None, failure_reason=None)

ParameterContextValidationStepDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'description': 'description', 'failure_reason': 'failureReason'}

property complete

Gets the complete of this ParameterContextValidationStepDTO. Whether or not this step has completed

Returns:

The complete of this ParameterContextValidationStepDTO.

Return type:

bool

property description

Gets the description of this ParameterContextValidationStepDTO. Explanation of what happens in this step

Returns:

The description of this ParameterContextValidationStepDTO.

Return type:

str

property failure_reason

Gets the failure_reason of this ParameterContextValidationStepDTO. An explanation of why this step failed, or null if this step did not fail

Returns:

The failure_reason of this ParameterContextValidationStepDTO.

Return type:

str

swagger_types = {'complete': 'bool', 'description': 'str', 'failure_reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterContextsEntity(current_time=None, parameter_contexts=None)

Bases: object

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

ParameterContextsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, parameter_contexts=None)

ParameterContextsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'current_time': 'currentTime', 'parameter_contexts': 'parameterContexts'}

property current_time

Gets the current_time of this ParameterContextsEntity. The current time on the system.

Returns:

The current_time of this ParameterContextsEntity.

Return type:

str

property parameter_contexts

Gets the parameter_contexts of this ParameterContextsEntity. The Parameter Contexts

Returns:

The parameter_contexts of this ParameterContextsEntity.

Return type:

list[ParameterContextEntity]

swagger_types = {'current_time': 'str', 'parameter_contexts': 'list[ParameterContextEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterDTO(description=None, inherited=None, name=None, parameter_context=None, provided=None, referenced_assets=None, referencing_components=None, sensitive=None, value=None, value_removed=None)

Bases: object

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

ParameterDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, inherited=None, name=None, parameter_context=None, provided=None, referenced_assets=None, referencing_components=None, sensitive=None, value=None, value_removed=None)

ParameterDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'inherited': 'inherited', 'name': 'name', 'parameter_context': 'parameterContext', 'provided': 'provided', 'referenced_assets': 'referencedAssets', 'referencing_components': 'referencingComponents', 'sensitive': 'sensitive', 'value': 'value', 'value_removed': 'valueRemoved'}

property description

Gets the description of this ParameterDTO. The description of the Parameter

Returns:

The description of this ParameterDTO.

Return type:

str

property inherited

Gets the inherited of this ParameterDTO. Whether or not the Parameter is inherited from another context

Returns:

The inherited of this ParameterDTO.

Return type:

bool

property name

Gets the name of this ParameterDTO. The name of the Parameter

Returns:

The name of this ParameterDTO.

Return type:

str

property parameter_context

Gets the parameter_context of this ParameterDTO.

Returns:

The parameter_context of this ParameterDTO.

Return type:

ParameterContextReferenceEntity

property provided

Gets the provided of this ParameterDTO. Whether or not the Parameter is provided by a ParameterProvider

Returns:

The provided of this ParameterDTO.

Return type:

bool

property referenced_assets

Gets the referenced_assets of this ParameterDTO. A list of identifiers of the assets that are referenced by the parameter

Returns:

The referenced_assets of this ParameterDTO.

Return type:

list[AssetReferenceDTO]

property referencing_components

Gets the referencing_components of this ParameterDTO. The set of all components in the flow that are referencing this Parameter

Returns:

The referencing_components of this ParameterDTO.

Return type:

list[AffectedComponentEntity]

property sensitive

Gets the sensitive of this ParameterDTO. Whether or not the Parameter is sensitive

Returns:

The sensitive of this ParameterDTO.

Return type:

bool

swagger_types = {'description': 'str', 'inherited': 'bool', 'name': 'str', 'parameter_context': 'ParameterContextReferenceEntity', 'provided': 'bool', 'referenced_assets': 'list[AssetReferenceDTO]', 'referencing_components': 'list[AffectedComponentEntity]', 'sensitive': 'bool', 'value': 'str', 'value_removed': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this ParameterDTO. The value of the Parameter

Returns:

The value of this ParameterDTO.

Return type:

str

property value_removed

Gets the value_removed of this ParameterDTO. Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The absence of the value may be used either to indicate that the value is not to be changed, or that the value is to be set to null (i.e., removed). This denotes which of the two scenarios is being encountered.

Returns:

The value_removed of this ParameterDTO.

Return type:

bool

class nipyapi.nifi.models.ParameterEntity(can_write=None, parameter=None)

Bases: object

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

ParameterEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(can_write=None, parameter=None)

ParameterEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_write': 'canWrite', 'parameter': 'parameter'}

property can_write

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

Returns:

The can_write of this ParameterEntity.

Return type:

bool

property parameter

Gets the parameter of this ParameterEntity.

Returns:

The parameter of this ParameterEntity.

Return type:

ParameterDTO

swagger_types = {'can_write': 'bool', 'parameter': 'ParameterDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterGroupConfigurationEntity(group_name=None, parameter_context_name=None, parameter_sensitivities=None, synchronized=None)

Bases: object

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

ParameterGroupConfigurationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(group_name=None, parameter_context_name=None, parameter_sensitivities=None, synchronized=None)

ParameterGroupConfigurationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'group_name': 'groupName', 'parameter_context_name': 'parameterContextName', 'parameter_sensitivities': 'parameterSensitivities', 'synchronized': 'synchronized'}

property group_name

Gets the group_name of this ParameterGroupConfigurationEntity. The name of the external parameter group to which the provided parameter names apply.

Returns:

The group_name of this ParameterGroupConfigurationEntity.

Return type:

str

property parameter_context_name

Gets the parameter_context_name of this ParameterGroupConfigurationEntity. The name of the ParameterContext that receives the parameters in this group

Returns:

The parameter_context_name of this ParameterGroupConfigurationEntity.

Return type:

str

property parameter_sensitivities

Gets the parameter_sensitivities of this ParameterGroupConfigurationEntity. All fetched parameter names that should be applied.

Returns:

The parameter_sensitivities of this ParameterGroupConfigurationEntity.

Return type:

dict(str, str)

swagger_types = {'group_name': 'str', 'parameter_context_name': 'str', 'parameter_sensitivities': 'dict(str, str)', 'synchronized': 'bool'}

property synchronized

Gets the synchronized of this ParameterGroupConfigurationEntity. True if this group should be synchronized to a ParameterContext, including creating one if it does not exist.

Returns:

The synchronized of this ParameterGroupConfigurationEntity.

Return type:

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderApplyParametersRequestDTO(complete=None, failure_reason=None, last_updated=None, parameter_context_updates=None, parameter_provider=None, percent_completed=None, referencing_components=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None)

Bases: object

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

ParameterProviderApplyParametersRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, failure_reason=None, last_updated=None, parameter_context_updates=None, parameter_provider=None, percent_completed=None, referencing_components=None, request_id=None, state=None, submission_time=None, update_steps=None, uri=None)

ParameterProviderApplyParametersRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'parameter_context_updates': 'parameterContextUpdates', 'parameter_provider': 'parameterProvider', 'percent_completed': 'percentCompleted', 'referencing_components': 'referencingComponents', 'request_id': 'requestId', 'state': 'state', 'submission_time': 'submissionTime', 'update_steps': 'updateSteps', 'uri': 'uri'}

property complete

Gets the complete of this ParameterProviderApplyParametersRequestDTO. Whether or not the request is completed

Returns:

The complete of this ParameterProviderApplyParametersRequestDTO.

Return type:

bool

property failure_reason

Gets the failure_reason of this ParameterProviderApplyParametersRequestDTO. The reason for the request failing, or null if the request has not failed

Returns:

The failure_reason of this ParameterProviderApplyParametersRequestDTO.

Return type:

str

property last_updated

Gets the last_updated of this ParameterProviderApplyParametersRequestDTO. The timestamp of when the request was last updated

Returns:

The last_updated of this ParameterProviderApplyParametersRequestDTO.

Return type:

datetime

property parameter_context_updates

Gets the parameter_context_updates of this ParameterProviderApplyParametersRequestDTO. The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed.

Returns:

The parameter_context_updates of this ParameterProviderApplyParametersRequestDTO.

Return type:

list[ParameterContextUpdateEntity]

property parameter_provider

Gets the parameter_provider of this ParameterProviderApplyParametersRequestDTO.

Returns:

The parameter_provider of this ParameterProviderApplyParametersRequestDTO.

Return type:

ParameterProviderDTO

property percent_completed

Gets the percent_completed of this ParameterProviderApplyParametersRequestDTO. A value between 0 and 100 (inclusive) indicating how close the request is to completion

Returns:

The percent_completed of this ParameterProviderApplyParametersRequestDTO.

Return type:

int

property referencing_components

Gets the referencing_components of this ParameterProviderApplyParametersRequestDTO. The components that are referenced by the update.

Returns:

The referencing_components of this ParameterProviderApplyParametersRequestDTO.

Return type:

list[AffectedComponentEntity]

property request_id

Gets the request_id of this ParameterProviderApplyParametersRequestDTO. The ID of the request

Returns:

The request_id of this ParameterProviderApplyParametersRequestDTO.

Return type:

str

property state

Gets the state of this ParameterProviderApplyParametersRequestDTO. A description of the current state of the request

Returns:

The state of this ParameterProviderApplyParametersRequestDTO.

Return type:

str

property submission_time

Gets the submission_time of this ParameterProviderApplyParametersRequestDTO. The timestamp of when the request was submitted

Returns:

The submission_time of this ParameterProviderApplyParametersRequestDTO.

Return type:

datetime

swagger_types = {'complete': 'bool', 'failure_reason': 'str', 'last_updated': 'datetime', 'parameter_context_updates': 'list[ParameterContextUpdateEntity]', 'parameter_provider': 'ParameterProviderDTO', 'percent_completed': 'int', 'referencing_components': 'list[AffectedComponentEntity]', 'request_id': 'str', 'state': 'str', 'submission_time': 'datetime', 'update_steps': 'list[ParameterProviderApplyParametersUpdateStepDTO]', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property update_steps

Gets the update_steps of this ParameterProviderApplyParametersRequestDTO. The steps that are required in order to complete the request, along with the status of each

Returns:

The update_steps of this ParameterProviderApplyParametersRequestDTO.

Return type:

list[ParameterProviderApplyParametersUpdateStepDTO]

property uri

Gets the uri of this ParameterProviderApplyParametersRequestDTO. The URI for the request

Returns:

The uri of this ParameterProviderApplyParametersRequestDTO.

Return type:

str

class nipyapi.nifi.models.ParameterProviderApplyParametersRequestEntity(request=None)

Bases: object

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

ParameterProviderApplyParametersRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(request=None)

ParameterProviderApplyParametersRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'request': 'request'}

property request

Gets the request of this ParameterProviderApplyParametersRequestEntity.

Returns:

The request of this ParameterProviderApplyParametersRequestEntity.

Return type:

ParameterProviderApplyParametersRequestDTO

swagger_types = {'request': 'ParameterProviderApplyParametersRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderApplyParametersUpdateStepDTO(complete=None, description=None, failure_reason=None)

Bases: object

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

ParameterProviderApplyParametersUpdateStepDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, description=None, failure_reason=None)

ParameterProviderApplyParametersUpdateStepDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'description': 'description', 'failure_reason': 'failureReason'}

property complete

Gets the complete of this ParameterProviderApplyParametersUpdateStepDTO. Whether or not this step has completed

Returns:

The complete of this ParameterProviderApplyParametersUpdateStepDTO.

Return type:

bool

property description

Gets the description of this ParameterProviderApplyParametersUpdateStepDTO. Explanation of what happens in this step

Returns:

The description of this ParameterProviderApplyParametersUpdateStepDTO.

Return type:

str

property failure_reason

Gets the failure_reason of this ParameterProviderApplyParametersUpdateStepDTO. An explanation of why this step failed, or null if this step did not fail

Returns:

The failure_reason of this ParameterProviderApplyParametersUpdateStepDTO.

Return type:

str

swagger_types = {'complete': 'bool', 'description': 'str', 'failure_reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderConfigurationDTO(parameter_group_name=None, parameter_provider_id=None, parameter_provider_name=None, synchronized=None)

Bases: object

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

ParameterProviderConfigurationDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(parameter_group_name=None, parameter_provider_id=None, parameter_provider_name=None, synchronized=None)

ParameterProviderConfigurationDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'parameter_group_name': 'parameterGroupName', 'parameter_provider_id': 'parameterProviderId', 'parameter_provider_name': 'parameterProviderName', 'synchronized': 'synchronized'}

property parameter_group_name

Gets the parameter_group_name of this ParameterProviderConfigurationDTO. The Parameter Group name that maps to the Parameter Context

Returns:

The parameter_group_name of this ParameterProviderConfigurationDTO.

Return type:

str

property parameter_provider_id

Gets the parameter_provider_id of this ParameterProviderConfigurationDTO. The ID of the Parameter Provider

Returns:

The parameter_provider_id of this ParameterProviderConfigurationDTO.

Return type:

str

property parameter_provider_name

Gets the parameter_provider_name of this ParameterProviderConfigurationDTO. The name of the Parameter Provider

Returns:

The parameter_provider_name of this ParameterProviderConfigurationDTO.

Return type:

str

swagger_types = {'parameter_group_name': 'str', 'parameter_provider_id': 'str', 'parameter_provider_name': 'str', 'synchronized': 'bool'}

property synchronized

Gets the synchronized of this ParameterProviderConfigurationDTO. True if the Parameter Context should receive the parameters from the mapped Parameter Group

Returns:

The synchronized of this ParameterProviderConfigurationDTO.

Return type:

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderConfigurationEntity(component=None, id=None, permissions=None)

Bases: object

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

ParameterProviderConfigurationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component=None, id=None, permissions=None)

ParameterProviderConfigurationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component

Gets the component of this ParameterProviderConfigurationEntity.

Returns:

The component of this ParameterProviderConfigurationEntity.

Return type:

ParameterProviderConfigurationDTO

property id

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

Returns:

The id of this ParameterProviderConfigurationEntity.

Return type:

str

property permissions

Gets the permissions of this ParameterProviderConfigurationEntity.

Returns:

The permissions of this ParameterProviderConfigurationEntity.

Return type:

PermissionsDTO

swagger_types = {'component': 'ParameterProviderConfigurationDTO', 'id': 'str', 'permissions': 'PermissionsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderDTO(affected_components=None, annotation_data=None, bundle=None, comments=None, custom_ui_url=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parameter_group_configurations=None, parameter_status=None, parent_group_id=None, persists_state=None, position=None, properties=None, referencing_parameter_contexts=None, restricted=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

Bases: object

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

ParameterProviderDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(affected_components=None, annotation_data=None, bundle=None, comments=None, custom_ui_url=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parameter_group_configurations=None, parameter_status=None, parent_group_id=None, persists_state=None, position=None, properties=None, referencing_parameter_contexts=None, restricted=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

ParameterProviderDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property affected_components

Gets the affected_components of this ParameterProviderDTO. The set of all components in the flow that are referencing Parameters provided by this provider

Returns:

The affected_components of this ParameterProviderDTO.

Return type:

list[AffectedComponentEntity]

property annotation_data

Gets the annotation_data of this ParameterProviderDTO. The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider.

Returns:

The annotation_data of this ParameterProviderDTO.

Return type:

str

attribute_map = {'affected_components': 'affectedComponents', 'annotation_data': 'annotationData', 'bundle': 'bundle', 'comments': 'comments', 'custom_ui_url': 'customUiUrl', 'deprecated': 'deprecated', 'descriptors': 'descriptors', 'extension_missing': 'extensionMissing', 'id': 'id', 'multiple_versions_available': 'multipleVersionsAvailable', 'name': 'name', 'parameter_group_configurations': 'parameterGroupConfigurations', 'parameter_status': 'parameterStatus', 'parent_group_id': 'parentGroupId', 'persists_state': 'persistsState', 'position': 'position', 'properties': 'properties', 'referencing_parameter_contexts': 'referencingParameterContexts', 'restricted': 'restricted', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

property bundle

Gets the bundle of this ParameterProviderDTO.

Returns:

The bundle of this ParameterProviderDTO.

Return type:

BundleDTO

property comments

Gets the comments of this ParameterProviderDTO. The comments of the parameter provider.

Returns:

The comments of this ParameterProviderDTO.

Return type:

str

property custom_ui_url

Gets the custom_ui_url of this ParameterProviderDTO. The URL for the custom configuration UI for the parameter provider.

Returns:

The custom_ui_url of this ParameterProviderDTO.

Return type:

str

property deprecated

Gets the deprecated of this ParameterProviderDTO. Whether the parameter provider has been deprecated.

Returns:

The deprecated of this ParameterProviderDTO.

Return type:

bool

property descriptors

Gets the descriptors of this ParameterProviderDTO. The descriptors for the parameter providers properties.

Returns:

The descriptors of this ParameterProviderDTO.

Return type:

dict(str, PropertyDescriptorDTO)

property extension_missing

Gets the extension_missing of this ParameterProviderDTO. Whether the underlying extension is missing.

Returns:

The extension_missing of this ParameterProviderDTO.

Return type:

bool

property id

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

Returns:

The id of this ParameterProviderDTO.

Return type:

str

property multiple_versions_available

Gets the multiple_versions_available of this ParameterProviderDTO. Whether the parameter provider has multiple versions available.

Returns:

The multiple_versions_available of this ParameterProviderDTO.

Return type:

bool

property name

Gets the name of this ParameterProviderDTO. The name of the parameter provider.

Returns:

The name of this ParameterProviderDTO.

Return type:

str

property parameter_group_configurations

Gets the parameter_group_configurations of this ParameterProviderDTO. Configuration for any fetched parameter groups.

Returns:

The parameter_group_configurations of this ParameterProviderDTO.

Return type:

list[ParameterGroupConfigurationEntity]

property parameter_status

Gets the parameter_status of this ParameterProviderDTO. The status of all provided parameters for this parameter provider

Returns:

The parameter_status of this ParameterProviderDTO.

Return type:

list[ParameterStatusDTO]

property parent_group_id

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

Returns:

The parent_group_id of this ParameterProviderDTO.

Return type:

str

property persists_state

Gets the persists_state of this ParameterProviderDTO. Whether the parameter provider persists state.

Returns:

The persists_state of this ParameterProviderDTO.

Return type:

bool

property position

Gets the position of this ParameterProviderDTO.

Returns:

The position of this ParameterProviderDTO.

Return type:

PositionDTO

property properties

Gets the properties of this ParameterProviderDTO. The properties of the parameter provider.

Returns:

The properties of this ParameterProviderDTO.

Return type:

dict(str, str)

property referencing_parameter_contexts

Gets the referencing_parameter_contexts of this ParameterProviderDTO. The Parameter Contexts that reference this Parameter Provider

Returns:

The referencing_parameter_contexts of this ParameterProviderDTO.

Return type:

list[ParameterProviderReferencingComponentEntity]

property restricted

Gets the restricted of this ParameterProviderDTO. Whether the parameter provider requires elevated privileges.

Returns:

The restricted of this ParameterProviderDTO.

Return type:

bool

swagger_types = {'affected_components': 'list[AffectedComponentEntity]', 'annotation_data': 'str', 'bundle': 'BundleDTO', 'comments': 'str', 'custom_ui_url': 'str', 'deprecated': 'bool', 'descriptors': 'dict(str, PropertyDescriptorDTO)', 'extension_missing': 'bool', 'id': 'str', 'multiple_versions_available': 'bool', 'name': 'str', 'parameter_group_configurations': 'list[ParameterGroupConfigurationEntity]', 'parameter_status': 'list[ParameterStatusDTO]', 'parent_group_id': 'str', 'persists_state': 'bool', 'position': 'PositionDTO', 'properties': 'dict(str, str)', 'referencing_parameter_contexts': 'list[ParameterProviderReferencingComponentEntity]', 'restricted': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ParameterProviderDTO. The fully qualified type of the parameter provider.

Returns:

The type of this ParameterProviderDTO.

Return type:

str

property validation_errors

Gets the validation_errors of this ParameterProviderDTO. Gets the validation errors from the parameter provider. These validation errors represent the problems with the parameter provider that must be resolved before it can be scheduled to run.

Returns:

The validation_errors of this ParameterProviderDTO.

Return type:

list[str]

property validation_status

Gets the validation_status of this ParameterProviderDTO. Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid)

Returns:

The validation_status of this ParameterProviderDTO.

Return type:

str

property versioned_component_id

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

Returns:

The versioned_component_id of this ParameterProviderDTO.

Return type:

str

class nipyapi.nifi.models.ParameterProviderDefinition(additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

Bases: object

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

ParameterProviderDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(additional_details=None, artifact=None, build_info=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

ParameterProviderDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property additional_details

Gets the additional_details of this ParameterProviderDefinition. Indicates if the component has additional details documentation

Returns:

The additional_details of this ParameterProviderDefinition.

Return type:

bool

property artifact

Gets the artifact of this ParameterProviderDefinition. The artifact name of the bundle that provides the referenced type.

Returns:

The artifact of this ParameterProviderDefinition.

Return type:

str

attribute_map = {'additional_details': 'additionalDetails', 'artifact': 'artifact', 'build_info': 'buildInfo', 'deprecated': 'deprecated', 'deprecation_alternatives': 'deprecationAlternatives', 'deprecation_reason': 'deprecationReason', 'dynamic_properties': 'dynamicProperties', 'explicit_restrictions': 'explicitRestrictions', 'group': 'group', 'property_descriptors': 'propertyDescriptors', 'provided_api_implementations': 'providedApiImplementations', 'restricted': 'restricted', 'restricted_explanation': 'restrictedExplanation', 'see_also': 'seeAlso', 'stateful': 'stateful', 'supports_dynamic_properties': 'supportsDynamicProperties', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'system_resource_considerations': 'systemResourceConsiderations', 'tags': 'tags', 'type': 'type', 'type_description': 'typeDescription', 'version': 'version'}

property build_info

Gets the build_info of this ParameterProviderDefinition.

Returns:

The build_info of this ParameterProviderDefinition.

Return type:

BuildInfo

property deprecated

Gets the deprecated of this ParameterProviderDefinition. Whether or not the component has been deprecated

Returns:

The deprecated of this ParameterProviderDefinition.

Return type:

bool

property deprecation_alternatives

Gets the deprecation_alternatives of this ParameterProviderDefinition. If this component has been deprecated, this optional field provides alternatives to use

Returns:

The deprecation_alternatives of this ParameterProviderDefinition.

Return type:

list[str]

property deprecation_reason

Gets the deprecation_reason of this ParameterProviderDefinition. If this component has been deprecated, this optional field can be used to provide an explanation

Returns:

The deprecation_reason of this ParameterProviderDefinition.

Return type:

str

property dynamic_properties

Gets the dynamic_properties of this ParameterProviderDefinition. Describes the dynamic properties supported by this component

Returns:

The dynamic_properties of this ParameterProviderDefinition.

Return type:

list[DynamicProperty]

property explicit_restrictions

Gets the explicit_restrictions of this ParameterProviderDefinition. Explicit restrictions that indicate a require permission to use the component

Returns:

The explicit_restrictions of this ParameterProviderDefinition.

Return type:

list[Restriction]

property group

Gets the group of this ParameterProviderDefinition. The group name of the bundle that provides the referenced type.

Returns:

The group of this ParameterProviderDefinition.

Return type:

str

property property_descriptors

Gets the property_descriptors of this ParameterProviderDefinition. Descriptions of configuration properties applicable to this component.

Returns:

The property_descriptors of this ParameterProviderDefinition.

Return type:

dict(str, PropertyDescriptor)

property provided_api_implementations

Gets the provided_api_implementations of this ParameterProviderDefinition. If this type represents a provider for an interface, this lists the APIs it implements

Returns:

The provided_api_implementations of this ParameterProviderDefinition.

Return type:

list[DefinedType]

property restricted

Gets the restricted of this ParameterProviderDefinition. Whether or not the component has a general restriction

Returns:

The restricted of this ParameterProviderDefinition.

Return type:

bool

property restricted_explanation

Gets the restricted_explanation of this ParameterProviderDefinition. An optional description of the general restriction

Returns:

The restricted_explanation of this ParameterProviderDefinition.

Return type:

str

property see_also

Gets the see_also of this ParameterProviderDefinition. The names of other component types that may be related

Returns:

The see_also of this ParameterProviderDefinition.

Return type:

list[str]

property stateful

Gets the stateful of this ParameterProviderDefinition.

Returns:

The stateful of this ParameterProviderDefinition.

Return type:

Stateful

property supports_dynamic_properties

Gets the supports_dynamic_properties of this ParameterProviderDefinition. Whether or not this component makes use of dynamic (user-set) properties.

Returns:

The supports_dynamic_properties of this ParameterProviderDefinition.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ParameterProviderDefinition. Whether or not this component makes use of sensitive dynamic (user-set) properties.

Returns:

The supports_sensitive_dynamic_properties of this ParameterProviderDefinition.

Return type:

bool

swagger_types = {'additional_details': 'bool', 'artifact': 'str', 'build_info': 'BuildInfo', 'deprecated': 'bool', 'deprecation_alternatives': 'list[str]', 'deprecation_reason': 'str', 'dynamic_properties': 'list[DynamicProperty]', 'explicit_restrictions': 'list[Restriction]', 'group': 'str', 'property_descriptors': 'dict(str, PropertyDescriptor)', 'provided_api_implementations': 'list[DefinedType]', 'restricted': 'bool', 'restricted_explanation': 'str', 'see_also': 'list[str]', 'stateful': 'Stateful', 'supports_dynamic_properties': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'system_resource_considerations': 'list[SystemResourceConsideration]', 'tags': 'list[str]', 'type': 'str', 'type_description': 'str', 'version': 'str'}

property system_resource_considerations

Gets the system_resource_considerations of this ParameterProviderDefinition. The system resource considerations for the given component

Returns:

The system_resource_considerations of this ParameterProviderDefinition.

Return type:

list[SystemResourceConsideration]

property tags

Gets the tags of this ParameterProviderDefinition. The tags associated with this type

Returns:

The tags of this ParameterProviderDefinition.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ParameterProviderDefinition. The fully-qualified class type

Returns:

The type of this ParameterProviderDefinition.

Return type:

str

property type_description

Gets the type_description of this ParameterProviderDefinition. The description of the type.

Returns:

The type_description of this ParameterProviderDefinition.

Return type:

str

property version

Gets the version of this ParameterProviderDefinition. The version of the bundle that provides the referenced type.

Returns:

The version of this ParameterProviderDefinition.

Return type:

str

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

Bases: object

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

ParameterProviderEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

ParameterProviderEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ParameterProviderEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ParameterProviderEntity.

Returns:

The component of this ParameterProviderEntity.

Return type:

ParameterProviderDTO

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ParameterProviderEntity.

Return type:

bool

property id

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

Returns:

The id of this ParameterProviderEntity.

Return type:

str

property permissions

Gets the permissions of this ParameterProviderEntity.

Returns:

The permissions of this ParameterProviderEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ParameterProviderEntity.

Returns:

The position of this ParameterProviderEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ParameterProviderEntity.

Returns:

The revision of this ParameterProviderEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ParameterProviderEntity.

Return type:

str

class nipyapi.nifi.models.ParameterProviderParameterApplicationEntity(disconnected_node_acknowledged=None, id=None, parameter_group_configurations=None, revision=None)

Bases: object

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

ParameterProviderParameterApplicationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, id=None, parameter_group_configurations=None, revision=None)

ParameterProviderParameterApplicationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'parameter_group_configurations': 'parameterGroupConfigurations', 'revision': 'revision'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ParameterProviderParameterApplicationEntity.

Return type:

bool

property id

Gets the id of this ParameterProviderParameterApplicationEntity. The id of the parameter provider.

Returns:

The id of this ParameterProviderParameterApplicationEntity.

Return type:

str

property parameter_group_configurations

Gets the parameter_group_configurations of this ParameterProviderParameterApplicationEntity. Configuration for the fetched Parameter Groups

Returns:

The parameter_group_configurations of this ParameterProviderParameterApplicationEntity.

Return type:

list[ParameterGroupConfigurationEntity]

property revision

Gets the revision of this ParameterProviderParameterApplicationEntity.

Returns:

The revision of this ParameterProviderParameterApplicationEntity.

Return type:

RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'id': 'str', 'parameter_group_configurations': 'list[ParameterGroupConfigurationEntity]', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderParameterFetchEntity(disconnected_node_acknowledged=None, id=None, revision=None)

Bases: object

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

ParameterProviderParameterFetchEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, id=None, revision=None)

ParameterProviderParameterFetchEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'revision': 'revision'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ParameterProviderParameterFetchEntity.

Return type:

bool

property id

Gets the id of this ParameterProviderParameterFetchEntity. The id of the parameter provider.

Returns:

The id of this ParameterProviderParameterFetchEntity.

Return type:

str

property revision

Gets the revision of this ParameterProviderParameterFetchEntity.

Returns:

The revision of this ParameterProviderParameterFetchEntity.

Return type:

RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'id': 'str', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderReference(bundle=None, identifier=None, name=None, type=None)

Bases: object

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

ParameterProviderReference - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, identifier=None, name=None, type=None)

ParameterProviderReference - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bundle': 'bundle', 'identifier': 'identifier', 'name': 'name', 'type': 'type'}

property bundle

Gets the bundle of this ParameterProviderReference.

Returns:

The bundle of this ParameterProviderReference.

Return type:

Bundle

property identifier

Gets the identifier of this ParameterProviderReference. The identifier of the parameter provider

Returns:

The identifier of this ParameterProviderReference.

Return type:

str

property name

Gets the name of this ParameterProviderReference. The name of the parameter provider

Returns:

The name of this ParameterProviderReference.

Return type:

str

swagger_types = {'bundle': 'Bundle', 'identifier': 'str', 'name': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ParameterProviderReference. The fully qualified name of the parameter provider class.

Returns:

The type of this ParameterProviderReference.

Return type:

str

class nipyapi.nifi.models.ParameterProviderReferencingComponentDTO(id=None, name=None)

Bases: object

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

ParameterProviderReferencingComponentDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None)

ParameterProviderReferencingComponentDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

Gets the id of this ParameterProviderReferencingComponentDTO. The id of the component referencing a parameter provider.

Returns:

The id of this ParameterProviderReferencingComponentDTO.

Return type:

str

property name

Gets the name of this ParameterProviderReferencingComponentDTO. The name of the component referencing a parameter provider.

Returns:

The name of this ParameterProviderReferencingComponentDTO.

Return type:

str

swagger_types = {'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ParameterProviderReferencingComponentEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

ParameterProviderReferencingComponentEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ParameterProviderReferencingComponentEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ParameterProviderReferencingComponentEntity.

Returns:

The component of this ParameterProviderReferencingComponentEntity.

Return type:

ParameterProviderReferencingComponentDTO

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ParameterProviderReferencingComponentEntity.

Return type:

bool

property id

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

Returns:

The id of this ParameterProviderReferencingComponentEntity.

Return type:

str

property permissions

Gets the permissions of this ParameterProviderReferencingComponentEntity.

Returns:

The permissions of this ParameterProviderReferencingComponentEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ParameterProviderReferencingComponentEntity.

Returns:

The position of this ParameterProviderReferencingComponentEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ParameterProviderReferencingComponentEntity.

Returns:

The revision of this ParameterProviderReferencingComponentEntity.

Return type:

RevisionDTO

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ParameterProviderReferencingComponentEntity.

Return type:

str

class nipyapi.nifi.models.ParameterProviderReferencingComponentsEntity(parameter_provider_referencing_components=None)

Bases: object

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

ParameterProviderReferencingComponentsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(parameter_provider_referencing_components=None)

ParameterProviderReferencingComponentsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'parameter_provider_referencing_components': 'parameterProviderReferencingComponents'}

property parameter_provider_referencing_components

Gets the parameter_provider_referencing_components of this ParameterProviderReferencingComponentsEntity.

Returns:

The parameter_provider_referencing_components of this ParameterProviderReferencingComponentsEntity.

Return type:

list[ParameterProviderReferencingComponentEntity]

swagger_types = {'parameter_provider_referencing_components': 'list[ParameterProviderReferencingComponentEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProviderTypesEntity(parameter_provider_types=None)

Bases: object

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

ParameterProviderTypesEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(parameter_provider_types=None)

ParameterProviderTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'parameter_provider_types': 'parameterProviderTypes'}

property parameter_provider_types

Gets the parameter_provider_types of this ParameterProviderTypesEntity.

Returns:

The parameter_provider_types of this ParameterProviderTypesEntity.

Return type:

list[DocumentedTypeDTO]

swagger_types = {'parameter_provider_types': 'list[DocumentedTypeDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterProvidersEntity(current_time=None, parameter_providers=None)

Bases: object

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

ParameterProvidersEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, parameter_providers=None)

ParameterProvidersEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'current_time': 'currentTime', 'parameter_providers': 'parameterProviders'}

property current_time

Gets the current_time of this ParameterProvidersEntity. The current time on the system.

Returns:

The current_time of this ParameterProvidersEntity.

Return type:

str

property parameter_providers

Gets the parameter_providers of this ParameterProvidersEntity.

Returns:

The parameter_providers of this ParameterProvidersEntity.

Return type:

list[ParameterProviderEntity]

swagger_types = {'current_time': 'str', 'parameter_providers': 'list[ParameterProviderEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ParameterStatusDTO(parameter=None, status=None)

Bases: object

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

ParameterStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(parameter=None, status=None)

ParameterStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'parameter': 'parameter', 'status': 'status'}

property parameter

Gets the parameter of this ParameterStatusDTO.

Returns:

The parameter of this ParameterStatusDTO.

Return type:

ParameterEntity

property status

Gets the status of this ParameterStatusDTO. Indicates the status of the parameter, compared to the existing parameter context

Returns:

The status of this ParameterStatusDTO.

Return type:

str

swagger_types = {'parameter': 'ParameterEntity', 'status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PasteRequestEntity(copy_response=None, disconnected_node_acknowledged=None, revision=None)

Bases: object

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

PasteRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(copy_response=None, disconnected_node_acknowledged=None, revision=None)

PasteRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'copy_response': 'copyResponse', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision'}

property copy_response

Gets the copy_response of this PasteRequestEntity.

Returns:

The copy_response of this PasteRequestEntity.

Return type:

CopyResponseEntity

property disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this PasteRequestEntity.

Returns:

The disconnected_node_acknowledged of this PasteRequestEntity.

Return type:

bool

property revision

Gets the revision of this PasteRequestEntity.

Returns:

The revision of this PasteRequestEntity.

Return type:

RevisionDTO

swagger_types = {'copy_response': 'CopyResponseEntity', 'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PasteResponseEntity(flow=None, revision=None)

Bases: object

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

PasteResponseEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow=None, revision=None)

PasteResponseEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow': 'flow', 'revision': 'revision'}

property flow

Gets the flow of this PasteResponseEntity.

Returns:

The flow of this PasteResponseEntity.

Return type:

FlowDTO

property revision

Gets the revision of this PasteResponseEntity.

Returns:

The revision of this PasteResponseEntity.

Return type:

RevisionDTO

swagger_types = {'flow': 'FlowDTO', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PeerDTO(flow_file_count=None, hostname=None, port=None, secure=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(flow_file_count=None, hostname=None, port=None, secure=None)

PeerDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property hostname

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

Returns:

The hostname of this PeerDTO.

Return type:

str

property port

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

Returns:

The port of this PeerDTO.

Return type:

int

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PeersEntity(peers=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(peers=None)

PeersEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'peers': 'peers'}

property peers

Gets the peers of this PeersEntity.

Returns:

The peers of this PeersEntity.

Return type:

list[PeerDTO]

swagger_types = {'peers': 'list[PeerDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PermissionsDTO(can_read=None, can_write=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, can_write=None)

PermissionsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PortDTO(allow_remote_access=None, comments=None, concurrently_schedulable_task_count=None, id=None, name=None, parent_group_id=None, port_function=None, position=None, state=None, transmitting=None, type=None, validation_errors=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(allow_remote_access=None, comments=None, concurrently_schedulable_task_count=None, id=None, name=None, parent_group_id=None, port_function=None, position=None, state=None, transmitting=None, type=None, validation_errors=None, versioned_component_id=None)

PortDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'id': 'id', 'name': 'name', 'parent_group_id': 'parentGroupId', 'port_function': 'portFunction', 'position': 'position', 'state': 'state', 'transmitting': 'transmitting', 'type': 'type', 'validation_errors': 'validationErrors', 'versioned_component_id': 'versionedComponentId'}

property comments

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

Returns:

The comments of this PortDTO.

Return type:

str

property 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

property id

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

Returns:

The id of this PortDTO.

Return type:

str

property name

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

Returns:

The name of this PortDTO.

Return type:

str

property 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

property port_function

Gets the port_function of this PortDTO. Specifies how the Port functions

Returns:

The port_function of this PortDTO.

Return type:

str

property position

Gets the position of this PortDTO.

Returns:

The position of this PortDTO.

Return type:

PositionDTO

property 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', 'id': 'str', 'name': 'str', 'parent_group_id': 'str', 'port_function': 'str', 'position': 'PositionDTO', 'state': 'str', 'transmitting': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property type

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

Returns:

The type of this PortDTO.

Return type:

str

property 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]

property 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

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

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

__eq__(other)

Returns true if both objects are equal

__init__(allow_remote_access=None, bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, port_type=None, position=None, revision=None, status=None, uri=None)

PortEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this PortEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this PortEntity.

Returns:

The component of this PortEntity.

Return type:

PortDTO

property 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

property id

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

Returns:

The id of this PortEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this PortEntity.

Returns:

The operate_permissions of this PortEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this PortEntity.

Returns:

The permissions of this PortEntity.

Return type:

PermissionsDTO

property port_type

Gets the port_type of this PortEntity.

Returns:

The port_type of this PortEntity.

Return type:

str

property position

Gets the position of this PortEntity.

Returns:

The position of this PortEntity.

Return type:

PositionDTO

property revision

Gets the revision of this PortEntity.

Returns:

The revision of this PortEntity.

Return type:

RevisionDTO

property status

Gets the status of this PortEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this PortEntity.

Return type:

str

class nipyapi.nifi.models.PortRunStatusEntity(disconnected_node_acknowledged=None, revision=None, state=None)

Bases: object

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

PortRunStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, revision=None, state=None)

PortRunStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision', 'state': 'state'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this PortRunStatusEntity.

Return type:

bool

property revision

Gets the revision of this PortRunStatusEntity.

Returns:

The revision of this PortRunStatusEntity.

Return type:

RevisionDTO

property state

Gets the state of this PortRunStatusEntity. The run status of the Port.

Returns:

The state of this PortRunStatusEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

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

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, run_status=None, stats_last_refreshed=None, transmitting=None)

PortStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this PortStatusDTO.

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

property 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

property id

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

Returns:

The id of this PortStatusDTO.

Return type:

str

property name

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

Returns:

The name of this PortStatusDTO.

Return type:

str

property 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]

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.PortStatusEntity(can_read=None, port_status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, port_status=None)

PortStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

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

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, bytes_in=None, bytes_out=None, flow_files_in=None, flow_files_out=None, group_id=None, id=None, input=None, name=None, output=None, run_status=None, transmitting=None)

PortStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property 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

property 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

property id

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

Returns:

The id of this PortStatusSnapshotDTO.

Return type:

str

property 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

property name

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

Returns:

The name of this PortStatusSnapshotDTO.

Return type:

str

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.PortStatusSnapshotEntity(can_read=None, id=None, port_status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, id=None, port_status_snapshot=None)

PortStatusSnapshotEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property id

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

Returns:

The id of this PortStatusSnapshotEntity.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.Position(x=None, y=None)

Bases: object

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

Position - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(x=None, y=None)

Position - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'x': 'x', 'y': 'y'}

swagger_types = {'x': 'float', 'y': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property x

Gets the x of this Position. The x coordinate.

Returns:

The x of this Position.

Return type:

float

property y

Gets the y of this Position. The y coordinate.

Returns:

The y of this Position.

Return type:

float

class nipyapi.nifi.models.PositionDTO(x=None, y=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(x=None, y=None)

PositionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'x': 'x', 'y': 'y'}

swagger_types = {'x': 'float', 'y': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property x

Gets the x of this PositionDTO. The x coordinate.

Returns:

The x of this PositionDTO.

Return type:

float

property y

Gets the y of this PositionDTO. The y coordinate.

Returns:

The y of this PositionDTO.

Return type:

float

class nipyapi.nifi.models.PreviousValueDTO(previous_value=None, timestamp=None, user_identity=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(previous_value=None, timestamp=None, user_identity=None)

PreviousValueDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.PrioritizerTypesEntity(prioritizer_types=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(prioritizer_types=None)

PrioritizerTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'prioritizer_types': 'prioritizerTypes'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessGroupDTO(active_remote_port_count=None, comments=None, contents=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, disabled_count=None, execution_engine=None, flowfile_concurrency=None, flowfile_outbound_policy=None, id=None, inactive_remote_port_count=None, input_port_count=None, invalid_count=None, local_input_port_count=None, local_output_port_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_port_count=None, parameter_context=None, parent_group_id=None, position=None, public_input_port_count=None, public_output_port_count=None, running_count=None, stale_count=None, stateless_flow_timeout=None, stateless_group_scheduled_state=None, stopped_count=None, sync_failure_count=None, up_to_date_count=None, version_control_information=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(active_remote_port_count=None, comments=None, contents=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, disabled_count=None, execution_engine=None, flowfile_concurrency=None, flowfile_outbound_policy=None, id=None, inactive_remote_port_count=None, input_port_count=None, invalid_count=None, local_input_port_count=None, local_output_port_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_port_count=None, parameter_context=None, parent_group_id=None, position=None, public_input_port_count=None, public_output_port_count=None, running_count=None, stale_count=None, stateless_flow_timeout=None, stateless_group_scheduled_state=None, stopped_count=None, sync_failure_count=None, up_to_date_count=None, version_control_information=None, versioned_component_id=None)

ProcessGroupDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'default_flow_file_expiration': 'defaultFlowFileExpiration', 'disabled_count': 'disabledCount', 'execution_engine': 'executionEngine', 'flowfile_concurrency': 'flowfileConcurrency', 'flowfile_outbound_policy': 'flowfileOutboundPolicy', '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', 'log_file_suffix': 'logFileSuffix', 'max_concurrent_tasks': 'maxConcurrentTasks', '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', 'stateless_flow_timeout': 'statelessFlowTimeout', 'stateless_group_scheduled_state': 'statelessGroupScheduledState', 'stopped_count': 'stoppedCount', 'sync_failure_count': 'syncFailureCount', 'up_to_date_count': 'upToDateCount', 'version_control_information': 'versionControlInformation', 'versioned_component_id': 'versionedComponentId'}

property comments

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

Returns:

The comments of this ProcessGroupDTO.

Return type:

str

property contents

Gets the contents of this ProcessGroupDTO.

Returns:

The contents of this ProcessGroupDTO.

Return type:

FlowSnippetDTO

property default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this ProcessGroupDTO. Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:

The default_back_pressure_data_size_threshold of this ProcessGroupDTO.

Return type:

str

property default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this ProcessGroupDTO. Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:

The default_back_pressure_object_threshold of this ProcessGroupDTO.

Return type:

int

property default_flow_file_expiration

Gets the default_flow_file_expiration of this ProcessGroupDTO. The default FlowFile Expiration for this Process Group.

Returns:

The default_flow_file_expiration of this ProcessGroupDTO.

Return type:

str

property 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

property execution_engine

Gets the execution_engine of this ProcessGroupDTO. The Execution Engine that should be used to run the flow represented by this Process Group.

Returns:

The execution_engine of this ProcessGroupDTO.

Return type:

str

property flowfile_concurrency

Gets the flowfile_concurrency of this ProcessGroupDTO. The FlowFile Concurrency for this Process Group.

Returns:

The flowfile_concurrency of this ProcessGroupDTO.

Return type:

str

property flowfile_outbound_policy

Gets the flowfile_outbound_policy of this ProcessGroupDTO. The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.

Returns:

The flowfile_outbound_policy of this ProcessGroupDTO.

Return type:

str

property id

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

Returns:

The id of this ProcessGroupDTO.

Return type:

str

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property log_file_suffix

Gets the log_file_suffix of this ProcessGroupDTO. The log file suffix for this Process Group for dedicated logging.

Returns:

The log_file_suffix of this ProcessGroupDTO.

Return type:

str

property max_concurrent_tasks

Gets the max_concurrent_tasks of this ProcessGroupDTO. The maximum number of concurrent tasks to use when running the flow using the Stateless Engine

Returns:

The max_concurrent_tasks of this ProcessGroupDTO.

Return type:

int

property name

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

Returns:

The name of this ProcessGroupDTO.

Return type:

str

property 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

property parameter_context

Gets the parameter_context of this ProcessGroupDTO.

Returns:

The parameter_context of this ProcessGroupDTO.

Return type:

ParameterContextReferenceEntity

property 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

property position

Gets the position of this ProcessGroupDTO.

Returns:

The position of this ProcessGroupDTO.

Return type:

PositionDTO

property 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

property 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

property 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

property 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

property stateless_flow_timeout

Gets the stateless_flow_timeout of this ProcessGroupDTO. The maximum amount of time that the flow can be run using the Stateless Engine before the flow times out

Returns:

The stateless_flow_timeout of this ProcessGroupDTO.

Return type:

str

property stateless_group_scheduled_state

Gets the stateless_group_scheduled_state of this ProcessGroupDTO. If the Process Group is configured to run in using the Stateless Engine, represents the current state. Otherwise, will be STOPPED.

Returns:

The stateless_group_scheduled_state of this ProcessGroupDTO.

Return type:

str

property 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', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': 'str', 'disabled_count': 'int', 'execution_engine': 'str', 'flowfile_concurrency': 'str', 'flowfile_outbound_policy': 'str', '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', 'log_file_suffix': 'str', 'max_concurrent_tasks': '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', 'stateless_flow_timeout': 'str', 'stateless_group_scheduled_state': 'str', 'stopped_count': 'int', 'sync_failure_count': 'int', 'up_to_date_count': 'int', 'version_control_information': 'VersionControlInformationDTO', 'versioned_component_id': 'str'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property version_control_information

Gets the version_control_information of this ProcessGroupDTO.

Returns:

The version_control_information of this ProcessGroupDTO.

Return type:

VersionControlInformationDTO

property 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

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

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

__eq__(other)

Returns true if both objects are equal

__init__(active_remote_port_count=None, bulletins=None, component=None, disabled_count=None, disconnected_node_acknowledged=None, id=None, inactive_remote_port_count=None, input_port_count=None, invalid_count=None, local_input_port_count=None, local_output_port_count=None, locally_modified_and_stale_count=None, locally_modified_count=None, output_port_count=None, parameter_context=None, permissions=None, position=None, process_group_update_strategy=None, public_input_port_count=None, public_output_port_count=None, revision=None, running_count=None, stale_count=None, status=None, stopped_count=None, sync_failure_count=None, up_to_date_count=None, uri=None, versioned_flow_snapshot=None, versioned_flow_state=None)

ProcessGroupEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'process_group_update_strategy': 'processGroupUpdateStrategy', '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'}

property bulletins

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

Returns:

The bulletins of this ProcessGroupEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ProcessGroupEntity.

Returns:

The component of this ProcessGroupEntity.

Return type:

ProcessGroupDTO

property 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

property 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

property id

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

Returns:

The id of this ProcessGroupEntity.

Return type:

str

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property parameter_context

Gets the parameter_context of this ProcessGroupEntity.

Returns:

The parameter_context of this ProcessGroupEntity.

Return type:

ParameterContextReferenceEntity

property permissions

Gets the permissions of this ProcessGroupEntity.

Returns:

The permissions of this ProcessGroupEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ProcessGroupEntity.

Returns:

The position of this ProcessGroupEntity.

Return type:

PositionDTO

property process_group_update_strategy

Gets the process_group_update_strategy of this ProcessGroupEntity. Determines the process group update strategy

Returns:

The process_group_update_strategy of this ProcessGroupEntity.

Return type:

str

property 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

property 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

property revision

Gets the revision of this ProcessGroupEntity.

Returns:

The revision of this ProcessGroupEntity.

Return type:

RevisionDTO

property 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

property 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

property status

Gets the status of this ProcessGroupEntity.

Returns:

The status of this ProcessGroupEntity.

Return type:

ProcessGroupStatusDTO

property 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', 'process_group_update_strategy': 'str', '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': 'RegisteredFlowSnapshot', 'versioned_flow_state': 'str'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property uri

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

Returns:

The uri of this ProcessGroupEntity.

Return type:

str

property versioned_flow_snapshot

Gets the versioned_flow_snapshot of this ProcessGroupEntity.

Returns:

The versioned_flow_snapshot of this ProcessGroupEntity.

Return type:

RegisteredFlowSnapshot

property 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

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

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

__eq__(other)

Returns true if both objects are equal

__init__(breadcrumb=None, flow=None, id=None, last_refreshed=None, parameter_context=None, parent_group_id=None, uri=None)

ProcessGroupFlowDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property breadcrumb

Gets the breadcrumb of this ProcessGroupFlowDTO.

Returns:

The breadcrumb of this ProcessGroupFlowDTO.

Return type:

FlowBreadcrumbEntity

property flow

Gets the flow of this ProcessGroupFlowDTO.

Returns:

The flow of this ProcessGroupFlowDTO.

Return type:

FlowDTO

property id

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

Returns:

The id of this ProcessGroupFlowDTO.

Return type:

str

property 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

property parameter_context

Gets the parameter_context of this ProcessGroupFlowDTO.

Returns:

The parameter_context of this ProcessGroupFlowDTO.

Return type:

ParameterContextReferenceEntity

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ProcessGroupFlowDTO.

Return type:

str

class nipyapi.nifi.models.ProcessGroupFlowEntity(permissions=None, process_group_flow=None, revision=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(permissions=None, process_group_flow=None, revision=None)

ProcessGroupFlowEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property permissions

Gets the permissions of this ProcessGroupFlowEntity.

Returns:

The permissions of this ProcessGroupFlowEntity.

Return type:

PermissionsDTO

property process_group_flow

Gets the process_group_flow of this ProcessGroupFlowEntity.

Returns:

The process_group_flow of this ProcessGroupFlowEntity.

Return type:

ProcessGroupFlowDTO

property revision

Gets the revision of this ProcessGroupFlowEntity.

Returns:

The revision of this ProcessGroupFlowEntity.

Return type:

RevisionDTO

swagger_types = {'permissions': 'PermissionsDTO', 'process_group_flow': 'ProcessGroupFlowDTO', 'revision': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessGroupImportEntity(disconnected_node_acknowledged=None, process_group_revision=None, versioned_flow_snapshot=None)

Bases: object

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

ProcessGroupImportEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, process_group_revision=None, versioned_flow_snapshot=None)

ProcessGroupImportEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'versioned_flow_snapshot': 'versionedFlowSnapshot'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ProcessGroupImportEntity.

Return type:

bool

property process_group_revision

Gets the process_group_revision of this ProcessGroupImportEntity.

Returns:

The process_group_revision of this ProcessGroupImportEntity.

Return type:

RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'process_group_revision': 'RevisionDTO', 'versioned_flow_snapshot': 'RegisteredFlowSnapshot'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow_snapshot

Gets the versioned_flow_snapshot of this ProcessGroupImportEntity.

Returns:

The versioned_flow_snapshot of this ProcessGroupImportEntity.

Return type:

RegisteredFlowSnapshot

class nipyapi.nifi.models.ProcessGroupNameDTO(id=None, name=None)

Bases: object

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

ProcessGroupNameDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None)

ProcessGroupNameDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

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

Returns:

The id of this ProcessGroupNameDTO.

Return type:

str

property name

Gets the name of this ProcessGroupNameDTO. The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group

Returns:

The name of this ProcessGroupNameDTO.

Return type:

str

swagger_types = {'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessGroupReplaceRequestDTO(complete=None, failure_reason=None, last_updated=None, percent_completed=None, process_group_id=None, request_id=None, state=None, uri=None)

Bases: object

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

ProcessGroupReplaceRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, failure_reason=None, last_updated=None, percent_completed=None, process_group_id=None, request_id=None, state=None, uri=None)

ProcessGroupReplaceRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'percent_completed': 'percentCompleted', 'process_group_id': 'processGroupId', 'request_id': 'requestId', 'state': 'state', 'uri': 'uri'}

property complete

Gets the complete of this ProcessGroupReplaceRequestDTO. Whether or not this request has completed

Returns:

The complete of this ProcessGroupReplaceRequestDTO.

Return type:

bool

property failure_reason

Gets the failure_reason of this ProcessGroupReplaceRequestDTO. An explanation of why this request failed, or null if this request has not failed

Returns:

The failure_reason of this ProcessGroupReplaceRequestDTO.

Return type:

str

property last_updated

Gets the last_updated of this ProcessGroupReplaceRequestDTO. The last time this request was updated.

Returns:

The last_updated of this ProcessGroupReplaceRequestDTO.

Return type:

str

property percent_completed

Gets the percent_completed of this ProcessGroupReplaceRequestDTO. The percentage complete for the request, between 0 and 100

Returns:

The percent_completed of this ProcessGroupReplaceRequestDTO.

Return type:

int

property process_group_id

Gets the process_group_id of this ProcessGroupReplaceRequestDTO. The unique ID of the Process Group being updated

Returns:

The process_group_id of this ProcessGroupReplaceRequestDTO.

Return type:

str

property request_id

Gets the request_id of this ProcessGroupReplaceRequestDTO. The unique ID of this request.

Returns:

The request_id of this ProcessGroupReplaceRequestDTO.

Return type:

str

property state

Gets the state of this ProcessGroupReplaceRequestDTO. The state of the request

Returns:

The state of this ProcessGroupReplaceRequestDTO.

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this ProcessGroupReplaceRequestDTO. The URI for future requests to this drop request.

Returns:

The uri of this ProcessGroupReplaceRequestDTO.

Return type:

str

class nipyapi.nifi.models.ProcessGroupReplaceRequestEntity(process_group_revision=None, request=None, versioned_flow_snapshot=None)

Bases: object

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

ProcessGroupReplaceRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(process_group_revision=None, request=None, versioned_flow_snapshot=None)

ProcessGroupReplaceRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'process_group_revision': 'processGroupRevision', 'request': 'request', 'versioned_flow_snapshot': 'versionedFlowSnapshot'}

property process_group_revision

Gets the process_group_revision of this ProcessGroupReplaceRequestEntity.

Returns:

The process_group_revision of this ProcessGroupReplaceRequestEntity.

Return type:

RevisionDTO

property request

Gets the request of this ProcessGroupReplaceRequestEntity.

Returns:

The request of this ProcessGroupReplaceRequestEntity.

Return type:

ProcessGroupReplaceRequestDTO

swagger_types = {'process_group_revision': 'RevisionDTO', 'request': 'ProcessGroupReplaceRequestDTO', 'versioned_flow_snapshot': 'RegisteredFlowSnapshot'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow_snapshot

Gets the versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity.

Returns:

The versioned_flow_snapshot of this ProcessGroupReplaceRequestEntity.

Return type:

RegisteredFlowSnapshot

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

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

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, id=None, name=None, node_snapshots=None, stats_last_refreshed=None)

ProcessGroupStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this ProcessGroupStatusDTO.

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

property id

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

Returns:

The id of this ProcessGroupStatusDTO.

Return type:

str

property name

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

Returns:

The name of this ProcessGroupStatusDTO.

Return type:

str

property 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]

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessGroupStatusEntity(can_read=None, process_group_status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, process_group_status=None)

ProcessGroupStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

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

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, bytes_in=None, bytes_out=None, bytes_queued=None, bytes_read=None, bytes_received=None, bytes_sent=None, bytes_transferred=None, bytes_written=None, connection_status_snapshots=None, flow_files_in=None, flow_files_out=None, flow_files_queued=None, flow_files_received=None, flow_files_sent=None, flow_files_transferred=None, id=None, input=None, input_port_status_snapshots=None, name=None, output=None, output_port_status_snapshots=None, process_group_status_snapshots=None, processing_nanos=None, processing_performance_status=None, processor_status_snapshots=None, queued=None, queued_count=None, queued_size=None, read=None, received=None, remote_process_group_status_snapshots=None, sent=None, stateless_active_thread_count=None, terminated_thread_count=None, transferred=None, versioned_flow_state=None, written=None)

ProcessGroupStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'processing_nanos': 'processingNanos', 'processing_performance_status': 'processingPerformanceStatus', 'processor_status_snapshots': 'processorStatusSnapshots', 'queued': 'queued', 'queued_count': 'queuedCount', 'queued_size': 'queuedSize', 'read': 'read', 'received': 'received', 'remote_process_group_status_snapshots': 'remoteProcessGroupStatusSnapshots', 'sent': 'sent', 'stateless_active_thread_count': 'statelessActiveThreadCount', 'terminated_thread_count': 'terminatedThreadCount', 'transferred': 'transferred', 'versioned_flow_state': 'versionedFlowState', 'written': 'written'}

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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]

property 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

property 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

property 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

property 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

property 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

property 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

property id

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

Returns:

The id of this ProcessGroupStatusSnapshotDTO.

Return type:

str

property 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

property 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]

property name

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

Returns:

The name of this ProcessGroupStatusSnapshotDTO.

Return type:

str

property 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

property 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]

property 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]

property processing_nanos

Gets the processing_nanos of this ProcessGroupStatusSnapshotDTO.

Returns:

The processing_nanos of this ProcessGroupStatusSnapshotDTO.

Return type:

int

property processing_performance_status

Gets the processing_performance_status of this ProcessGroupStatusSnapshotDTO.

Returns:

The processing_performance_status of this ProcessGroupStatusSnapshotDTO.

Return type:

ProcessingPerformanceStatusDTO

property 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]

property 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

property 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

property 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

property 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

property 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

property 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]

property 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

property stateless_active_thread_count

Gets the stateless_active_thread_count of this ProcessGroupStatusSnapshotDTO. The current number of active threads for the Process Group, when running in Stateless mode.

Returns:

The stateless_active_thread_count of this ProcessGroupStatusSnapshotDTO.

Return type:

int

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]', 'processing_nanos': 'int', 'processing_performance_status': 'ProcessingPerformanceStatusDTO', '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', 'stateless_active_thread_count': 'int', 'terminated_thread_count': 'int', 'transferred': 'str', 'versioned_flow_state': 'str', 'written': 'str'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property 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

property 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

class nipyapi.nifi.models.ProcessGroupStatusSnapshotEntity(can_read=None, id=None, process_group_status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, id=None, process_group_status_snapshot=None)

ProcessGroupStatusSnapshotEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property id

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

Returns:

The id of this ProcessGroupStatusSnapshotEntity.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessGroupUploadEntity(disconnected_node_acknowledged=None, flow_snapshot=None, group_id=None, group_name=None, position_dto=None, revision_dto=None)

Bases: object

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

ProcessGroupUploadEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, flow_snapshot=None, group_id=None, group_name=None, position_dto=None, revision_dto=None)

ProcessGroupUploadEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'flow_snapshot': 'flowSnapshot', 'group_id': 'groupId', 'group_name': 'groupName', 'position_dto': 'positionDTO', 'revision_dto': 'revisionDTO'}

property disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this ProcessGroupUploadEntity.

Returns:

The disconnected_node_acknowledged of this ProcessGroupUploadEntity.

Return type:

bool

property flow_snapshot

Gets the flow_snapshot of this ProcessGroupUploadEntity.

Returns:

The flow_snapshot of this ProcessGroupUploadEntity.

Return type:

RegisteredFlowSnapshot

property group_id

Gets the group_id of this ProcessGroupUploadEntity.

Returns:

The group_id of this ProcessGroupUploadEntity.

Return type:

str

property group_name

Gets the group_name of this ProcessGroupUploadEntity.

Returns:

The group_name of this ProcessGroupUploadEntity.

Return type:

str

property position_dto

Gets the position_dto of this ProcessGroupUploadEntity.

Returns:

The position_dto of this ProcessGroupUploadEntity.

Return type:

PositionDTO

property revision_dto

Gets the revision_dto of this ProcessGroupUploadEntity.

Returns:

The revision_dto of this ProcessGroupUploadEntity.

Return type:

RevisionDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'flow_snapshot': 'RegisteredFlowSnapshot', 'group_id': 'str', 'group_name': 'str', 'position_dto': 'PositionDTO', 'revision_dto': 'RevisionDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessGroupsEntity(process_groups=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(process_groups=None)

ProcessGroupsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'process_groups': 'processGroups'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessgroupsUploadBody(client_id=None, disconnected_node_acknowledged=False, file=None, group_name=None, position_x=None, position_y=None)

Bases: object

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

ProcessgroupsUploadBody - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(client_id=None, disconnected_node_acknowledged=False, file=None, group_name=None, position_x=None, position_y=None)

ProcessgroupsUploadBody - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'client_id': 'clientId', 'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'file': 'file', 'group_name': 'groupName', 'position_x': 'positionX', 'position_y': 'positionY'}

property client_id

Gets the client_id of this ProcessgroupsUploadBody. The client id.

Returns:

The client_id of this ProcessgroupsUploadBody.

Return type:

str

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ProcessgroupsUploadBody.

Return type:

bool

property file

Gets the file of this ProcessgroupsUploadBody.

Returns:

The file of this ProcessgroupsUploadBody.

Return type:

object

property group_name

Gets the group_name of this ProcessgroupsUploadBody. The process group name.

Returns:

The group_name of this ProcessgroupsUploadBody.

Return type:

str

property position_x

Gets the position_x of this ProcessgroupsUploadBody. The process group X position.

Returns:

The position_x of this ProcessgroupsUploadBody.

Return type:

float

property position_y

Gets the position_y of this ProcessgroupsUploadBody. The process group Y position.

Returns:

The position_y of this ProcessgroupsUploadBody.

Return type:

float

swagger_types = {'client_id': 'str', 'disconnected_node_acknowledged': 'bool', 'file': 'object', 'group_name': 'str', 'position_x': 'float', 'position_y': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessingPerformanceStatusDTO(content_read_duration=None, content_write_duration=None, cpu_duration=None, garbage_collection_duration=None, identifier=None, session_commit_duration=None)

Bases: object

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

ProcessingPerformanceStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(content_read_duration=None, content_write_duration=None, cpu_duration=None, garbage_collection_duration=None, identifier=None, session_commit_duration=None)

ProcessingPerformanceStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'content_read_duration': 'contentReadDuration', 'content_write_duration': 'contentWriteDuration', 'cpu_duration': 'cpuDuration', 'garbage_collection_duration': 'garbageCollectionDuration', 'identifier': 'identifier', 'session_commit_duration': 'sessionCommitDuration'}

property content_read_duration

Gets the content_read_duration of this ProcessingPerformanceStatusDTO. The number of nanoseconds has spent to read content in the last 5 minutes.

Returns:

The content_read_duration of this ProcessingPerformanceStatusDTO.

Return type:

int

property content_write_duration

Gets the content_write_duration of this ProcessingPerformanceStatusDTO. The number of nanoseconds has spent to write content in the last 5 minutes.

Returns:

The content_write_duration of this ProcessingPerformanceStatusDTO.

Return type:

int

property cpu_duration

Gets the cpu_duration of this ProcessingPerformanceStatusDTO. The number of nanoseconds has spent on CPU usage in the last 5 minutes.

Returns:

The cpu_duration of this ProcessingPerformanceStatusDTO.

Return type:

int

property garbage_collection_duration

Gets the garbage_collection_duration of this ProcessingPerformanceStatusDTO. The number of nanoseconds has spent running garbage collection in the last 5 minutes.

Returns:

The garbage_collection_duration of this ProcessingPerformanceStatusDTO.

Return type:

int

property identifier

Gets the identifier of this ProcessingPerformanceStatusDTO. The unique ID of the process group that the Processor belongs to

Returns:

The identifier of this ProcessingPerformanceStatusDTO.

Return type:

str

property session_commit_duration

Gets the session_commit_duration of this ProcessingPerformanceStatusDTO. The number of nanoseconds has spent running to commit sessions the last 5 minutes.

Returns:

The session_commit_duration of this ProcessingPerformanceStatusDTO.

Return type:

int

swagger_types = {'content_read_duration': 'int', 'content_write_duration': 'int', 'cpu_duration': 'int', 'garbage_collection_duration': 'int', 'identifier': 'str', 'session_commit_duration': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorConfigDTO(annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, comments=None, concurrently_schedulable_task_count=None, custom_ui_url=None, default_concurrent_tasks=None, default_scheduling_period=None, descriptors=None, execution_node=None, loss_tolerant=None, max_backoff_period=None, penalty_duration=None, properties=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduling_period=None, scheduling_strategy=None, sensitive_dynamic_property_names=None, yield_duration=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, comments=None, concurrently_schedulable_task_count=None, custom_ui_url=None, default_concurrent_tasks=None, default_scheduling_period=None, descriptors=None, execution_node=None, loss_tolerant=None, max_backoff_period=None, penalty_duration=None, properties=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduling_period=None, scheduling_strategy=None, sensitive_dynamic_property_names=None, yield_duration=None)

ProcessorConfigDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'backoff_mechanism': 'backoffMechanism', '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', 'max_backoff_period': 'maxBackoffPeriod', 'penalty_duration': 'penaltyDuration', 'properties': 'properties', 'retried_relationships': 'retriedRelationships', 'retry_count': 'retryCount', 'run_duration_millis': 'runDurationMillis', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'sensitive_dynamic_property_names': 'sensitiveDynamicPropertyNames', 'yield_duration': 'yieldDuration'}

property 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]

property backoff_mechanism

Gets the backoff_mechanism of this ProcessorConfigDTO. Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR. See BackoffMechanism.class for more details.

Returns:

The backoff_mechanism of this ProcessorConfigDTO.

Return type:

str

property 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

property comments

Gets the comments of this ProcessorConfigDTO. The comments for the processor.

Returns:

The comments of this ProcessorConfigDTO.

Return type:

str

property 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

property 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

property 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)

property 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)

property descriptors

Gets the descriptors of this ProcessorConfigDTO. Descriptors for the processor’s properties.

Returns:

The descriptors of this ProcessorConfigDTO.

Return type:

dict(str, PropertyDescriptorDTO)

property 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

property 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

property max_backoff_period

Gets the max_backoff_period of this ProcessorConfigDTO. Maximum amount of time to be waited during a retry period.

Returns:

The max_backoff_period of this ProcessorConfigDTO.

Return type:

str

property 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

property 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)

property retried_relationships

Gets the retried_relationships of this ProcessorConfigDTO. All the relationships should be retried.

Returns:

The retried_relationships of this ProcessorConfigDTO.

Return type:

list[str]

property retry_count

Gets the retry_count of this ProcessorConfigDTO. Overall number of retries.

Returns:

The retry_count of this ProcessorConfigDTO.

Return type:

int

property 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

property 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

property scheduling_strategy

Gets the scheduling_strategy of this ProcessorConfigDTO. Indicates how the processor should be scheduled to run.

Returns:

The scheduling_strategy of this ProcessorConfigDTO.

Return type:

str

property sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ProcessorConfigDTO. Set of sensitive dynamic property names

Returns:

The sensitive_dynamic_property_names of this ProcessorConfigDTO.

Return type:

list[str]

swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'backoff_mechanism': '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', 'max_backoff_period': 'str', 'penalty_duration': 'str', 'properties': 'dict(str, str)', 'retried_relationships': 'list[str]', 'retry_count': 'int', 'run_duration_millis': 'int', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'sensitive_dynamic_property_names': 'list[str]', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ProcessorConfiguration(configuration=None, processor_class_name=None)

Bases: object

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

ProcessorConfiguration - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(configuration=None, processor_class_name=None)

ProcessorConfiguration - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'configuration': 'configuration', 'processor_class_name': 'processorClassName'}

property configuration

Gets the configuration of this ProcessorConfiguration. A description of how the Processor should be configured in order to accomplish the use case

Returns:

The configuration of this ProcessorConfiguration.

Return type:

str

property processor_class_name

Gets the processor_class_name of this ProcessorConfiguration. The fully qualified classname of the Processor that should be used to accomplish the use case

Returns:

The processor_class_name of this ProcessorConfiguration.

Return type:

str

swagger_types = {'configuration': 'str', 'processor_class_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorDTO(bundle=None, config=None, deprecated=None, description=None, execution_node_restricted=None, extension_missing=None, id=None, input_requirement=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, relationships=None, restricted=None, state=None, style=None, supports_batching=None, supports_parallel_processing=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, config=None, deprecated=None, description=None, execution_node_restricted=None, extension_missing=None, id=None, input_requirement=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, relationships=None, restricted=None, state=None, style=None, supports_batching=None, supports_parallel_processing=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

ProcessorDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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_parallel_processing': 'supportsParallelProcessing', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'type': 'type', 'validation_errors': 'validationErrors', 'validation_status': 'validationStatus', 'versioned_component_id': 'versionedComponentId'}

property bundle

Gets the bundle of this ProcessorDTO.

Returns:

The bundle of this ProcessorDTO.

Return type:

BundleDTO

property config

Gets the config of this ProcessorDTO.

Returns:

The config of this ProcessorDTO.

Return type:

ProcessorConfigDTO

property deprecated

Gets the deprecated of this ProcessorDTO. Whether the processor has been deprecated.

Returns:

The deprecated of this ProcessorDTO.

Return type:

bool

property description

Gets the description of this ProcessorDTO. The description of the processor.

Returns:

The description of this ProcessorDTO.

Return type:

str

property 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

property 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

property id

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

Returns:

The id of this ProcessorDTO.

Return type:

str

property 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

property 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

property name

Gets the name of this ProcessorDTO. The name of the processor.

Returns:

The name of this ProcessorDTO.

Return type:

str

property 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

property persists_state

Gets the persists_state of this ProcessorDTO. Whether the processor persists state.

Returns:

The persists_state of this ProcessorDTO.

Return type:

bool

property position

Gets the position of this ProcessorDTO.

Returns:

The position of this ProcessorDTO.

Return type:

PositionDTO

property 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]

property restricted

Gets the restricted of this ProcessorDTO. Whether the processor requires elevated privileges.

Returns:

The restricted of this ProcessorDTO.

Return type:

bool

property state

Gets the state of this ProcessorDTO. The state of the processor

Returns:

The state of this ProcessorDTO.

Return type:

str

property 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)

property 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

property 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

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ProcessorDTO. Whether the processor supports sensitive dynamic properties.

Returns:

The supports_sensitive_dynamic_properties 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_parallel_processing': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ProcessorDTO. The type of the processor.

Returns:

The type of this ProcessorDTO.

Return type:

str

property 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]

property 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

property 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

class nipyapi.nifi.models.ProcessorDefinition(additional_details=None, artifact=None, build_info=None, default_bulletin_level=None, default_concurrent_tasks_by_scheduling_strategy=None, default_penalty_duration=None, default_scheduling_period_by_scheduling_strategy=None, default_scheduling_strategy=None, default_yield_duration=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, dynamic_relationship=None, explicit_restrictions=None, group=None, input_requirement=None, multi_processor_use_cases=None, primary_node_only=None, property_descriptors=None, provided_api_implementations=None, reads_attributes=None, restricted=None, restricted_explanation=None, see_also=None, side_effect_free=None, stateful=None, supported_relationships=None, supported_scheduling_strategies=None, supports_batching=None, supports_dynamic_properties=None, supports_dynamic_relationships=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, trigger_serially=None, trigger_when_any_destination_available=None, trigger_when_empty=None, type=None, type_description=None, use_cases=None, version=None, writes_attributes=None)

Bases: object

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

ProcessorDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(additional_details=None, artifact=None, build_info=None, default_bulletin_level=None, default_concurrent_tasks_by_scheduling_strategy=None, default_penalty_duration=None, default_scheduling_period_by_scheduling_strategy=None, default_scheduling_strategy=None, default_yield_duration=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, dynamic_relationship=None, explicit_restrictions=None, group=None, input_requirement=None, multi_processor_use_cases=None, primary_node_only=None, property_descriptors=None, provided_api_implementations=None, reads_attributes=None, restricted=None, restricted_explanation=None, see_also=None, side_effect_free=None, stateful=None, supported_relationships=None, supported_scheduling_strategies=None, supports_batching=None, supports_dynamic_properties=None, supports_dynamic_relationships=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, trigger_serially=None, trigger_when_any_destination_available=None, trigger_when_empty=None, type=None, type_description=None, use_cases=None, version=None, writes_attributes=None)

ProcessorDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property additional_details

Gets the additional_details of this ProcessorDefinition. Indicates if the component has additional details documentation

Returns:

The additional_details of this ProcessorDefinition.

Return type:

bool

property artifact

Gets the artifact of this ProcessorDefinition. The artifact name of the bundle that provides the referenced type.

Returns:

The artifact of this ProcessorDefinition.

Return type:

str

attribute_map = {'additional_details': 'additionalDetails', 'artifact': 'artifact', 'build_info': 'buildInfo', 'default_bulletin_level': 'defaultBulletinLevel', 'default_concurrent_tasks_by_scheduling_strategy': 'defaultConcurrentTasksBySchedulingStrategy', 'default_penalty_duration': 'defaultPenaltyDuration', 'default_scheduling_period_by_scheduling_strategy': 'defaultSchedulingPeriodBySchedulingStrategy', 'default_scheduling_strategy': 'defaultSchedulingStrategy', 'default_yield_duration': 'defaultYieldDuration', 'deprecated': 'deprecated', 'deprecation_alternatives': 'deprecationAlternatives', 'deprecation_reason': 'deprecationReason', 'dynamic_properties': 'dynamicProperties', 'dynamic_relationship': 'dynamicRelationship', 'explicit_restrictions': 'explicitRestrictions', 'group': 'group', 'input_requirement': 'inputRequirement', 'multi_processor_use_cases': 'multiProcessorUseCases', 'primary_node_only': 'primaryNodeOnly', 'property_descriptors': 'propertyDescriptors', 'provided_api_implementations': 'providedApiImplementations', 'reads_attributes': 'readsAttributes', 'restricted': 'restricted', 'restricted_explanation': 'restrictedExplanation', 'see_also': 'seeAlso', 'side_effect_free': 'sideEffectFree', 'stateful': 'stateful', 'supported_relationships': 'supportedRelationships', 'supported_scheduling_strategies': 'supportedSchedulingStrategies', 'supports_batching': 'supportsBatching', 'supports_dynamic_properties': 'supportsDynamicProperties', 'supports_dynamic_relationships': 'supportsDynamicRelationships', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'system_resource_considerations': 'systemResourceConsiderations', 'tags': 'tags', 'trigger_serially': 'triggerSerially', 'trigger_when_any_destination_available': 'triggerWhenAnyDestinationAvailable', 'trigger_when_empty': 'triggerWhenEmpty', 'type': 'type', 'type_description': 'typeDescription', 'use_cases': 'useCases', 'version': 'version', 'writes_attributes': 'writesAttributes'}

property build_info

Gets the build_info of this ProcessorDefinition.

Returns:

The build_info of this ProcessorDefinition.

Return type:

BuildInfo

property default_bulletin_level

Gets the default_bulletin_level of this ProcessorDefinition. The default bulletin level, such as WARN, INFO, DEBUG, etc.

Returns:

The default_bulletin_level of this ProcessorDefinition.

Return type:

str

property default_concurrent_tasks_by_scheduling_strategy

Gets the default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition. The default concurrent tasks for each scheduling strategy.

Returns:

The default_concurrent_tasks_by_scheduling_strategy of this ProcessorDefinition.

Return type:

dict(str, int)

property default_penalty_duration

Gets the default_penalty_duration of this ProcessorDefinition. The default penalty duration as a time period, such as “30 sec”.

Returns:

The default_penalty_duration of this ProcessorDefinition.

Return type:

str

property default_scheduling_period_by_scheduling_strategy

Gets the default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition. The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as “30 sec”.

Returns:

The default_scheduling_period_by_scheduling_strategy of this ProcessorDefinition.

Return type:

dict(str, str)

property default_scheduling_strategy

Gets the default_scheduling_strategy of this ProcessorDefinition. The default scheduling strategy for the processor.

Returns:

The default_scheduling_strategy of this ProcessorDefinition.

Return type:

str

property default_yield_duration

Gets the default_yield_duration of this ProcessorDefinition. The default yield duration as a time period, such as “1 sec”.

Returns:

The default_yield_duration of this ProcessorDefinition.

Return type:

str

property deprecated

Gets the deprecated of this ProcessorDefinition. Whether or not the component has been deprecated

Returns:

The deprecated of this ProcessorDefinition.

Return type:

bool

property deprecation_alternatives

Gets the deprecation_alternatives of this ProcessorDefinition. If this component has been deprecated, this optional field provides alternatives to use

Returns:

The deprecation_alternatives of this ProcessorDefinition.

Return type:

list[str]

property deprecation_reason

Gets the deprecation_reason of this ProcessorDefinition. If this component has been deprecated, this optional field can be used to provide an explanation

Returns:

The deprecation_reason of this ProcessorDefinition.

Return type:

str

property dynamic_properties

Gets the dynamic_properties of this ProcessorDefinition. Describes the dynamic properties supported by this component

Returns:

The dynamic_properties of this ProcessorDefinition.

Return type:

list[DynamicProperty]

property dynamic_relationship

Gets the dynamic_relationship of this ProcessorDefinition.

Returns:

The dynamic_relationship of this ProcessorDefinition.

Return type:

DynamicRelationship

property explicit_restrictions

Gets the explicit_restrictions of this ProcessorDefinition. Explicit restrictions that indicate a require permission to use the component

Returns:

The explicit_restrictions of this ProcessorDefinition.

Return type:

list[Restriction]

property group

Gets the group of this ProcessorDefinition. The group name of the bundle that provides the referenced type.

Returns:

The group of this ProcessorDefinition.

Return type:

str

property input_requirement

Gets the input_requirement of this ProcessorDefinition. Any input requirements this processor has.

Returns:

The input_requirement of this ProcessorDefinition.

Return type:

str

property multi_processor_use_cases

Gets the multi_processor_use_cases of this ProcessorDefinition. A list of use cases that have been documented that involve this Processor in conjunction with other Processors

Returns:

The multi_processor_use_cases of this ProcessorDefinition.

Return type:

list[MultiProcessorUseCase]

property primary_node_only

Gets the primary_node_only of this ProcessorDefinition. Whether or not this processor should be scheduled only on the primary node in a cluster.

Returns:

The primary_node_only of this ProcessorDefinition.

Return type:

bool

property property_descriptors

Gets the property_descriptors of this ProcessorDefinition. Descriptions of configuration properties applicable to this component.

Returns:

The property_descriptors of this ProcessorDefinition.

Return type:

dict(str, PropertyDescriptor)

property provided_api_implementations

Gets the provided_api_implementations of this ProcessorDefinition. If this type represents a provider for an interface, this lists the APIs it implements

Returns:

The provided_api_implementations of this ProcessorDefinition.

Return type:

list[DefinedType]

property reads_attributes

Gets the reads_attributes of this ProcessorDefinition. The FlowFile attributes this processor reads

Returns:

The reads_attributes of this ProcessorDefinition.

Return type:

list[Attribute]

property restricted

Gets the restricted of this ProcessorDefinition. Whether or not the component has a general restriction

Returns:

The restricted of this ProcessorDefinition.

Return type:

bool

property restricted_explanation

Gets the restricted_explanation of this ProcessorDefinition. An optional description of the general restriction

Returns:

The restricted_explanation of this ProcessorDefinition.

Return type:

str

property see_also

Gets the see_also of this ProcessorDefinition. The names of other component types that may be related

Returns:

The see_also of this ProcessorDefinition.

Return type:

list[str]

property side_effect_free

Gets the side_effect_free of this ProcessorDefinition. Whether or not this processor is considered side-effect free. Side-effect free indicate that the processor’s operations on FlowFiles can be safely repeated across process sessions.

Returns:

The side_effect_free of this ProcessorDefinition.

Return type:

bool

property stateful

Gets the stateful of this ProcessorDefinition.

Returns:

The stateful of this ProcessorDefinition.

Return type:

Stateful

property supported_relationships

Gets the supported_relationships of this ProcessorDefinition. The supported relationships for this processor.

Returns:

The supported_relationships of this ProcessorDefinition.

Return type:

list[Relationship]

property supported_scheduling_strategies

Gets the supported_scheduling_strategies of this ProcessorDefinition. The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.

Returns:

The supported_scheduling_strategies of this ProcessorDefinition.

Return type:

list[str]

property supports_batching

Gets the supports_batching of this ProcessorDefinition. Whether or not this processor supports batching. If a Processor uses this annotation, it allows the Framework to batch calls to session commits, as well as allowing the Framework to return the same session multiple times.

Returns:

The supports_batching of this ProcessorDefinition.

Return type:

bool

property supports_dynamic_properties

Gets the supports_dynamic_properties of this ProcessorDefinition. Whether or not this component makes use of dynamic (user-set) properties.

Returns:

The supports_dynamic_properties of this ProcessorDefinition.

Return type:

bool

property supports_dynamic_relationships

Gets the supports_dynamic_relationships of this ProcessorDefinition. Whether or not this processor supports dynamic relationships.

Returns:

The supports_dynamic_relationships of this ProcessorDefinition.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ProcessorDefinition. Whether or not this component makes use of sensitive dynamic (user-set) properties.

Returns:

The supports_sensitive_dynamic_properties of this ProcessorDefinition.

Return type:

bool

swagger_types = {'additional_details': 'bool', 'artifact': 'str', 'build_info': 'BuildInfo', 'default_bulletin_level': 'str', 'default_concurrent_tasks_by_scheduling_strategy': 'dict(str, int)', 'default_penalty_duration': 'str', 'default_scheduling_period_by_scheduling_strategy': 'dict(str, str)', 'default_scheduling_strategy': 'str', 'default_yield_duration': 'str', 'deprecated': 'bool', 'deprecation_alternatives': 'list[str]', 'deprecation_reason': 'str', 'dynamic_properties': 'list[DynamicProperty]', 'dynamic_relationship': 'DynamicRelationship', 'explicit_restrictions': 'list[Restriction]', 'group': 'str', 'input_requirement': 'str', 'multi_processor_use_cases': 'list[MultiProcessorUseCase]', 'primary_node_only': 'bool', 'property_descriptors': 'dict(str, PropertyDescriptor)', 'provided_api_implementations': 'list[DefinedType]', 'reads_attributes': 'list[Attribute]', 'restricted': 'bool', 'restricted_explanation': 'str', 'see_also': 'list[str]', 'side_effect_free': 'bool', 'stateful': 'Stateful', 'supported_relationships': 'list[Relationship]', 'supported_scheduling_strategies': 'list[str]', 'supports_batching': 'bool', 'supports_dynamic_properties': 'bool', 'supports_dynamic_relationships': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'system_resource_considerations': 'list[SystemResourceConsideration]', 'tags': 'list[str]', 'trigger_serially': 'bool', 'trigger_when_any_destination_available': 'bool', 'trigger_when_empty': 'bool', 'type': 'str', 'type_description': 'str', 'use_cases': 'list[UseCase]', 'version': 'str', 'writes_attributes': 'list[Attribute]'}

property system_resource_considerations

Gets the system_resource_considerations of this ProcessorDefinition. The system resource considerations for the given component

Returns:

The system_resource_considerations of this ProcessorDefinition.

Return type:

list[SystemResourceConsideration]

property tags

Gets the tags of this ProcessorDefinition. The tags associated with this type

Returns:

The tags of this ProcessorDefinition.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property trigger_serially

Gets the trigger_serially of this ProcessorDefinition. Whether or not this processor should be triggered serially (i.e. no concurrent execution).

Returns:

The trigger_serially of this ProcessorDefinition.

Return type:

bool

property trigger_when_any_destination_available

Gets the trigger_when_any_destination_available of this ProcessorDefinition. Whether or not this processor should be triggered when any destination queue has room.

Returns:

The trigger_when_any_destination_available of this ProcessorDefinition.

Return type:

bool

property trigger_when_empty

Gets the trigger_when_empty of this ProcessorDefinition. Whether or not this processor should be triggered when incoming queues are empty.

Returns:

The trigger_when_empty of this ProcessorDefinition.

Return type:

bool

property type

Gets the type of this ProcessorDefinition. The fully-qualified class type

Returns:

The type of this ProcessorDefinition.

Return type:

str

property type_description

Gets the type_description of this ProcessorDefinition. The description of the type.

Returns:

The type_description of this ProcessorDefinition.

Return type:

str

property use_cases

Gets the use_cases of this ProcessorDefinition. A list of use cases that have been documented for this Processor

Returns:

The use_cases of this ProcessorDefinition.

Return type:

list[UseCase]

property version

Gets the version of this ProcessorDefinition. The version of the bundle that provides the referenced type.

Returns:

The version of this ProcessorDefinition.

Return type:

str

property writes_attributes

Gets the writes_attributes of this ProcessorDefinition. The FlowFile attributes this processor writes/updates

Returns:

The writes_attributes of this ProcessorDefinition.

Return type:

list[Attribute]

class nipyapi.nifi.models.ProcessorEntity(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, input_requirement=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, input_requirement=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None)

ProcessorEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ProcessorEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ProcessorEntity.

Returns:

The component of this ProcessorEntity.

Return type:

ProcessorDTO

property 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

property id

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

Returns:

The id of this ProcessorEntity.

Return type:

str

property 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

property operate_permissions

Gets the operate_permissions of this ProcessorEntity.

Returns:

The operate_permissions of this ProcessorEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this ProcessorEntity.

Returns:

The permissions of this ProcessorEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ProcessorEntity.

Returns:

The position of this ProcessorEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ProcessorEntity.

Returns:

The revision of this ProcessorEntity.

Return type:

RevisionDTO

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ProcessorEntity.

Return type:

str

class nipyapi.nifi.models.ProcessorRunStatusDetailsDTO(active_thread_count=None, id=None, name=None, run_status=None, validation_errors=None)

Bases: object

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

ProcessorRunStatusDetailsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, id=None, name=None, run_status=None, validation_errors=None)

ProcessorRunStatusDetailsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property active_thread_count

Gets the active_thread_count of this ProcessorRunStatusDetailsDTO. The current number of threads that the processor is currently using

Returns:

The active_thread_count of this ProcessorRunStatusDetailsDTO.

Return type:

int

attribute_map = {'active_thread_count': 'activeThreadCount', 'id': 'id', 'name': 'name', 'run_status': 'runStatus', 'validation_errors': 'validationErrors'}

property id

Gets the id of this ProcessorRunStatusDetailsDTO. The ID of the processor

Returns:

The id of this ProcessorRunStatusDetailsDTO.

Return type:

str

property name

Gets the name of this ProcessorRunStatusDetailsDTO. The name of the processor

Returns:

The name of this ProcessorRunStatusDetailsDTO.

Return type:

str

property run_status

Gets the run_status of this ProcessorRunStatusDetailsDTO. The run status of the processor

Returns:

The run_status of this ProcessorRunStatusDetailsDTO.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property validation_errors

Gets the validation_errors of this ProcessorRunStatusDetailsDTO. The processor’s validation errors

Returns:

The validation_errors of this ProcessorRunStatusDetailsDTO.

Return type:

list[str]

class nipyapi.nifi.models.ProcessorRunStatusDetailsEntity(permissions=None, revision=None, run_status_details=None)

Bases: object

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

ProcessorRunStatusDetailsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(permissions=None, revision=None, run_status_details=None)

ProcessorRunStatusDetailsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'permissions': 'permissions', 'revision': 'revision', 'run_status_details': 'runStatusDetails'}

property permissions

Gets the permissions of this ProcessorRunStatusDetailsEntity.

Returns:

The permissions of this ProcessorRunStatusDetailsEntity.

Return type:

PermissionsDTO

property revision

Gets the revision of this ProcessorRunStatusDetailsEntity.

Returns:

The revision of this ProcessorRunStatusDetailsEntity.

Return type:

RevisionDTO

property run_status_details

Gets the run_status_details of this ProcessorRunStatusDetailsEntity.

Returns:

The run_status_details of this ProcessorRunStatusDetailsEntity.

Return type:

ProcessorRunStatusDetailsDTO

swagger_types = {'permissions': 'PermissionsDTO', 'revision': 'RevisionDTO', 'run_status_details': 'ProcessorRunStatusDetailsDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorRunStatusEntity(disconnected_node_acknowledged=None, revision=None, state=None)

Bases: object

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

ProcessorRunStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, revision=None, state=None)

ProcessorRunStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision', 'state': 'state'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ProcessorRunStatusEntity.

Return type:

bool

property revision

Gets the revision of this ProcessorRunStatusEntity.

Returns:

The revision of this ProcessorRunStatusEntity.

Return type:

RevisionDTO

property state

Gets the state of this ProcessorRunStatusEntity. The run status of the Processor.

Returns:

The state of this ProcessorRunStatusEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorStatusDTO(aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, run_status=None, stats_last_refreshed=None, type=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, run_status=None, stats_last_refreshed=None, type=None)

ProcessorStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this ProcessorStatusDTO.

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

property 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

property id

Gets the id of this ProcessorStatusDTO. The unique ID of the Processor

Returns:

The id of this ProcessorStatusDTO.

Return type:

str

property name

Gets the name of this ProcessorStatusDTO. The name of the Processor

Returns:

The name of this ProcessorStatusDTO.

Return type:

str

property 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]

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ProcessorStatusDTO. The type of the Processor

Returns:

The type of this ProcessorStatusDTO.

Return type:

str

class nipyapi.nifi.models.ProcessorStatusEntity(can_read=None, processor_status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, processor_status=None)

ProcessorStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'processor_status': 'processorStatus'}

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorStatusSnapshotDTO(active_thread_count=None, bytes_in=None, bytes_out=None, bytes_read=None, bytes_written=None, execution_node=None, flow_files_in=None, flow_files_out=None, group_id=None, id=None, input=None, name=None, output=None, processing_performance_status=None, read=None, run_status=None, task_count=None, tasks=None, tasks_duration=None, tasks_duration_nanos=None, terminated_thread_count=None, type=None, written=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, bytes_in=None, bytes_out=None, bytes_read=None, bytes_written=None, execution_node=None, flow_files_in=None, flow_files_out=None, group_id=None, id=None, input=None, name=None, output=None, processing_performance_status=None, read=None, run_status=None, task_count=None, tasks=None, tasks_duration=None, tasks_duration_nanos=None, terminated_thread_count=None, type=None, written=None)

ProcessorStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'processing_performance_status': 'processingPerformanceStatus', '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'}

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property id

Gets the id of this ProcessorStatusSnapshotDTO. The id of the processor.

Returns:

The id of this ProcessorStatusSnapshotDTO.

Return type:

str

property 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

property name

Gets the name of this ProcessorStatusSnapshotDTO. The name of the prcessor.

Returns:

The name of this ProcessorStatusSnapshotDTO.

Return type:

str

property 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

property processing_performance_status

Gets the processing_performance_status of this ProcessorStatusSnapshotDTO.

Returns:

The processing_performance_status of this ProcessorStatusSnapshotDTO.

Return type:

ProcessingPerformanceStatusDTO

property 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

property 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', 'processing_performance_status': 'ProcessingPerformanceStatusDTO', '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'}

property 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

property 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

property 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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ProcessorStatusSnapshotDTO. The type of the processor.

Returns:

The type of this ProcessorStatusSnapshotDTO.

Return type:

str

property 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

class nipyapi.nifi.models.ProcessorStatusSnapshotEntity(can_read=None, id=None, processor_status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, id=None, processor_status_snapshot=None)

ProcessorStatusSnapshotEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'id': 'id', 'processor_status_snapshot': 'processorStatusSnapshot'}

property 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

property id

Gets the id of this ProcessorStatusSnapshotEntity. The id of the processor.

Returns:

The id of this ProcessorStatusSnapshotEntity.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorTypesEntity(processor_types=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(processor_types=None)

ProcessorTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'processor_types': 'processorTypes'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorsEntity(processors=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(processors=None)

ProcessorsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'processors': 'processors'}

property processors

Gets the processors of this ProcessorsEntity.

Returns:

The processors of this ProcessorsEntity.

Return type:

list[ProcessorEntity]

swagger_types = {'processors': 'list[ProcessorEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProcessorsRunStatusDetailsEntity(run_status_details=None)

Bases: object

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

ProcessorsRunStatusDetailsEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(run_status_details=None)

ProcessorsRunStatusDetailsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'run_status_details': 'runStatusDetails'}

property run_status_details

Gets the run_status_details of this ProcessorsRunStatusDetailsEntity.

Returns:

The run_status_details of this ProcessorsRunStatusDetailsEntity.

Return type:

list[ProcessorRunStatusDetailsEntity]

swagger_types = {'run_status_details': 'list[ProcessorRunStatusDetailsEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

PropertyAllowableValue - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, display_name=None, value=None)

PropertyAllowableValue - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this PropertyAllowableValue. The description of the value, e.g., the behavior it produces.

Returns:

The description of this PropertyAllowableValue.

Return type:

str

property display_name

Gets the display_name of this PropertyAllowableValue. The display name of the value, if different from the internal value

Returns:

The display_name of this PropertyAllowableValue.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this PropertyAllowableValue. The internal value

Returns:

The value of this PropertyAllowableValue.

Return type:

str

class nipyapi.nifi.models.PropertyDependency(dependent_values=None, property_display_name=None, property_name=None)

Bases: object

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

PropertyDependency - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(dependent_values=None, property_display_name=None, property_name=None)

PropertyDependency - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'dependent_values': 'dependentValues', 'property_display_name': 'propertyDisplayName', 'property_name': 'propertyName'}

property dependent_values

Gets the dependent_values of this PropertyDependency. The values that satisfy the dependency

Returns:

The dependent_values of this PropertyDependency.

Return type:

list[str]

property property_display_name

Gets the property_display_name of this PropertyDependency. The name of the property that is depended upon

Returns:

The property_display_name of this PropertyDependency.

Return type:

str

property property_name

Gets the property_name of this PropertyDependency. The name of the property that is depended upon

Returns:

The property_name of this PropertyDependency.

Return type:

str

swagger_types = {'dependent_values': 'list[str]', 'property_display_name': 'str', 'property_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PropertyDependencyDTO(dependent_values=None, property_name=None)

Bases: object

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

PropertyDependencyDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(dependent_values=None, property_name=None)

PropertyDependencyDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'dependent_values': 'dependentValues', 'property_name': 'propertyName'}

property dependent_values

Gets the dependent_values of this PropertyDependencyDTO. The values for the property that satisfies the dependency, or null if the dependency is satisfied by the presence of any value for the associated property name

Returns:

The dependent_values of this PropertyDependencyDTO.

Return type:

list[str]

property property_name

Gets the property_name of this PropertyDependencyDTO. The name of the property that is being depended upon

Returns:

The property_name of this PropertyDependencyDTO.

Return type:

str

swagger_types = {'dependent_values': 'list[str]', 'property_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PropertyDescriptor(allowable_values=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, expression_language_scope=None, expression_language_scope_description=None, name=None, required=None, resource_definition=None, sensitive=None, type_provided_by_value=None, valid_regex=None, validator=None)

Bases: object

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

PropertyDescriptor - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(allowable_values=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, expression_language_scope=None, expression_language_scope_description=None, name=None, required=None, resource_definition=None, sensitive=None, type_provided_by_value=None, valid_regex=None, validator=None)

PropertyDescriptor - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property allowable_values

Gets the allowable_values of this PropertyDescriptor. A list of the allowable values for the property

Returns:

The allowable_values of this PropertyDescriptor.

Return type:

list[PropertyAllowableValue]

attribute_map = {'allowable_values': 'allowableValues', 'default_value': 'defaultValue', 'dependencies': 'dependencies', 'description': 'description', 'display_name': 'displayName', 'dynamic': 'dynamic', 'expression_language_scope': 'expressionLanguageScope', 'expression_language_scope_description': 'expressionLanguageScopeDescription', 'name': 'name', 'required': 'required', 'resource_definition': 'resourceDefinition', 'sensitive': 'sensitive', 'type_provided_by_value': 'typeProvidedByValue', 'valid_regex': 'validRegex', 'validator': 'validator'}

property default_value

Gets the default_value of this PropertyDescriptor. The default value if a user-set value is not specified

Returns:

The default_value of this PropertyDescriptor.

Return type:

str

property dependencies

Gets the dependencies of this PropertyDescriptor. The dependencies that this property has on other properties

Returns:

The dependencies of this PropertyDescriptor.

Return type:

list[PropertyDependency]

property description

Gets the description of this PropertyDescriptor. The description of what the property does

Returns:

The description of this PropertyDescriptor.

Return type:

str

property display_name

Gets the display_name of this PropertyDescriptor. The display name of the property key, if different from the name

Returns:

The display_name of this PropertyDescriptor.

Return type:

str

property dynamic

Gets the dynamic of this PropertyDescriptor. Whether or not the descriptor is for a dynamically added property

Returns:

The dynamic of this PropertyDescriptor.

Return type:

bool

property expression_language_scope

Gets the expression_language_scope of this PropertyDescriptor. The scope of expression language supported by this property

Returns:

The expression_language_scope of this PropertyDescriptor.

Return type:

str

property expression_language_scope_description

Gets the expression_language_scope_description of this PropertyDescriptor. The description of the expression language scope supported by this property

Returns:

The expression_language_scope_description of this PropertyDescriptor.

Return type:

str

property name

Gets the name of this PropertyDescriptor. The name of the property key

Returns:

The name of this PropertyDescriptor.

Return type:

str

property required

Gets the required of this PropertyDescriptor. Whether or not the property is required for the component

Returns:

The required of this PropertyDescriptor.

Return type:

bool

property resource_definition

Gets the resource_definition of this PropertyDescriptor.

Returns:

The resource_definition of this PropertyDescriptor.

Return type:

PropertyResourceDefinition

property sensitive

Gets the sensitive of this PropertyDescriptor. Whether or not the value of the property is considered sensitive (e.g., passwords and keys)

Returns:

The sensitive of this PropertyDescriptor.

Return type:

bool

swagger_types = {'allowable_values': 'list[PropertyAllowableValue]', 'default_value': 'str', 'dependencies': 'list[PropertyDependency]', 'description': 'str', 'display_name': 'str', 'dynamic': 'bool', 'expression_language_scope': 'str', 'expression_language_scope_description': 'str', 'name': 'str', 'required': 'bool', 'resource_definition': 'PropertyResourceDefinition', 'sensitive': 'bool', 'type_provided_by_value': 'DefinedType', 'valid_regex': 'str', 'validator': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type_provided_by_value

Gets the type_provided_by_value of this PropertyDescriptor.

Returns:

The type_provided_by_value of this PropertyDescriptor.

Return type:

DefinedType

property valid_regex

Gets the valid_regex of this PropertyDescriptor. A regular expression that can be used to validate the value of this property

Returns:

The valid_regex of this PropertyDescriptor.

Return type:

str

property validator

Gets the validator of this PropertyDescriptor. Name of the validator used for this property descriptor

Returns:

The validator of this PropertyDescriptor.

Return type:

str

class nipyapi.nifi.models.PropertyDescriptorDTO(allowable_values=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, expression_language_scope=None, identifies_controller_service=None, identifies_controller_service_bundle=None, name=None, required=None, sensitive=None, supports_el=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(allowable_values=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, expression_language_scope=None, identifies_controller_service=None, identifies_controller_service_bundle=None, name=None, required=None, sensitive=None, supports_el=None)

PropertyDescriptorDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'dependencies': 'dependencies', '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'}

property 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

property dependencies

Gets the dependencies of this PropertyDescriptorDTO. A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.

Returns:

The dependencies of this PropertyDescriptorDTO.

Return type:

list[PropertyDependencyDTO]

property 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

property 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

property dynamic

Gets the dynamic of this PropertyDescriptorDTO. Whether the property is dynamic (user-defined).

Returns:

The dynamic of this PropertyDescriptorDTO.

Return type:

bool

property 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

property 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

property identifies_controller_service_bundle

Gets the identifies_controller_service_bundle of this PropertyDescriptorDTO.

Returns:

The identifies_controller_service_bundle of this PropertyDescriptorDTO.

Return type:

BundleDTO

property name

Gets the name of this PropertyDescriptorDTO. The name for the property.

Returns:

The name of this PropertyDescriptorDTO.

Return type:

str

property required

Gets the required of this PropertyDescriptorDTO. Whether the property is required.

Returns:

The required of this PropertyDescriptorDTO.

Return type:

bool

property 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

property 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', 'dependencies': 'list[PropertyDependencyDTO]', '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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PropertyDescriptorEntity(property_descriptor=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(property_descriptor=None)

PropertyDescriptorEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'property_descriptor': 'propertyDescriptor'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PropertyHistoryDTO(previous_values=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(previous_values=None)

PropertyHistoryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'previous_values': 'previousValues'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.PropertyResourceDefinition(cardinality=None, resource_types=None)

Bases: object

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

PropertyResourceDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cardinality=None, resource_types=None)

PropertyResourceDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cardinality': 'cardinality', 'resource_types': 'resourceTypes'}

property cardinality

Gets the cardinality of this PropertyResourceDefinition. The cardinality of the resource definition (i.e. single or multiple)

Returns:

The cardinality of this PropertyResourceDefinition.

Return type:

str

property resource_types

Gets the resource_types of this PropertyResourceDefinition. The types of resources that can be referenced

Returns:

The resource_types of this PropertyResourceDefinition.

Return type:

list[str]

swagger_types = {'cardinality': 'str', 'resource_types': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceDTO(expiration=None, finished=None, id=None, percent_completed=None, request=None, results=None, submission_time=None, uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(expiration=None, finished=None, id=None, percent_completed=None, request=None, results=None, submission_time=None, uri=None)

ProvenanceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'expiration': 'expiration', 'finished': 'finished', 'id': 'id', 'percent_completed': 'percentCompleted', 'request': 'request', 'results': 'results', 'submission_time': 'submissionTime', 'uri': 'uri'}

property expiration

Gets the expiration of this ProvenanceDTO. The timestamp when the query will expire.

Returns:

The expiration of this ProvenanceDTO.

Return type:

str

property finished

Gets the finished of this ProvenanceDTO. Whether the query has finished.

Returns:

The finished of this ProvenanceDTO.

Return type:

bool

property id

Gets the id of this ProvenanceDTO. The id of the provenance query.

Returns:

The id of this ProvenanceDTO.

Return type:

str

property percent_completed

Gets the percent_completed of this ProvenanceDTO. The current percent complete.

Returns:

The percent_completed of this ProvenanceDTO.

Return type:

int

property request

Gets the request of this ProvenanceDTO.

Returns:

The request of this ProvenanceDTO.

Return type:

ProvenanceRequestDTO

property results

Gets the results of this ProvenanceDTO.

Returns:

The results of this ProvenanceDTO.

Return type:

ProvenanceResultsDTO

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ProvenanceEntity(provenance=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(provenance=None)

ProvenanceEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'provenance': 'provenance'}

property provenance

Gets the provenance of this ProvenanceEntity.

Returns:

The provenance of this ProvenanceEntity.

Return type:

ProvenanceDTO

swagger_types = {'provenance': 'ProvenanceDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceEventDTO(alternate_identifier_uri=None, attributes=None, child_uuids=None, cluster_node_address=None, cluster_node_id=None, component_id=None, component_name=None, component_type=None, content_equal=None, details=None, event_duration=None, event_id=None, event_time=None, event_type=None, file_size=None, file_size_bytes=None, flow_file_uuid=None, group_id=None, id=None, input_content_available=None, input_content_claim_container=None, input_content_claim_file_size=None, input_content_claim_file_size_bytes=None, input_content_claim_identifier=None, input_content_claim_offset=None, input_content_claim_section=None, lineage_duration=None, output_content_available=None, output_content_claim_container=None, output_content_claim_file_size=None, output_content_claim_file_size_bytes=None, output_content_claim_identifier=None, output_content_claim_offset=None, output_content_claim_section=None, parent_uuids=None, relationship=None, replay_available=None, replay_explanation=None, source_connection_identifier=None, source_system_flow_file_id=None, transit_uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(alternate_identifier_uri=None, attributes=None, child_uuids=None, cluster_node_address=None, cluster_node_id=None, component_id=None, component_name=None, component_type=None, content_equal=None, details=None, event_duration=None, event_id=None, event_time=None, event_type=None, file_size=None, file_size_bytes=None, flow_file_uuid=None, group_id=None, id=None, input_content_available=None, input_content_claim_container=None, input_content_claim_file_size=None, input_content_claim_file_size_bytes=None, input_content_claim_identifier=None, input_content_claim_offset=None, input_content_claim_section=None, lineage_duration=None, output_content_available=None, output_content_claim_container=None, output_content_claim_file_size=None, output_content_claim_file_size_bytes=None, output_content_claim_identifier=None, output_content_claim_offset=None, output_content_claim_section=None, parent_uuids=None, relationship=None, replay_available=None, replay_explanation=None, source_connection_identifier=None, source_system_flow_file_id=None, transit_uri=None)

ProvenanceEventDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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]

property 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]

property 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

property 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

property 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

property 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

property 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

property 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

property details

Gets the details of this ProvenanceEventDTO. The event details.

Returns:

The details of this ProvenanceEventDTO.

Return type:

str

property event_duration

Gets the event_duration of this ProvenanceEventDTO. The event duration in milliseconds.

Returns:

The event_duration of this ProvenanceEventDTO.

Return type:

int

property 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

property event_time

Gets the event_time of this ProvenanceEventDTO. The timestamp of the event.

Returns:

The event_time of this ProvenanceEventDTO.

Return type:

str

property event_type

Gets the event_type of this ProvenanceEventDTO. The type of the event.

Returns:

The event_type of this ProvenanceEventDTO.

Return type:

str

property 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

property 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

property 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

property 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

property id

Gets the id of this ProvenanceEventDTO. The event uuid.

Returns:

The id of this ProvenanceEventDTO.

Return type:

str

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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

property 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]

property 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

property 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

property 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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.ProvenanceEventEntity(provenance_event=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(provenance_event=None)

ProvenanceEventEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'provenance_event': 'provenanceEvent'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceLinkDTO(flow_file_uuid=None, millis=None, source_id=None, target_id=None, timestamp=None)

Bases: object

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

ProvenanceLinkDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(flow_file_uuid=None, millis=None, source_id=None, target_id=None, timestamp=None)

ProvenanceLinkDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_file_uuid': 'flowFileUuid', 'millis': 'millis', 'source_id': 'sourceId', 'target_id': 'targetId', 'timestamp': 'timestamp'}

property flow_file_uuid

Gets the flow_file_uuid of this ProvenanceLinkDTO. The flowfile uuid that traversed the link.

Returns:

The flow_file_uuid of this ProvenanceLinkDTO.

Return type:

str

property millis

Gets the millis of this ProvenanceLinkDTO. The timestamp of this link in milliseconds.

Returns:

The millis of this ProvenanceLinkDTO.

Return type:

int

property source_id

Gets the source_id of this ProvenanceLinkDTO. The source node id of the link.

Returns:

The source_id of this ProvenanceLinkDTO.

Return type:

str

swagger_types = {'flow_file_uuid': 'str', 'millis': 'int', 'source_id': 'str', 'target_id': 'str', 'timestamp': 'str'}

property target_id

Gets the target_id of this ProvenanceLinkDTO. The target node id of the link.

Returns:

The target_id of this ProvenanceLinkDTO.

Return type:

str

property timestamp

Gets the timestamp of this ProvenanceLinkDTO. The timestamp of the link (based on the destination).

Returns:

The timestamp of this ProvenanceLinkDTO.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceNodeDTO(child_uuids=None, cluster_node_identifier=None, event_type=None, flow_file_uuid=None, id=None, millis=None, parent_uuids=None, timestamp=None, type=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(child_uuids=None, cluster_node_identifier=None, event_type=None, flow_file_uuid=None, id=None, millis=None, parent_uuids=None, timestamp=None, type=None)

ProvenanceNodeDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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]

property 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

property 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

property 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

property id

Gets the id of this ProvenanceNodeDTO. The id of the node.

Returns:

The id of this ProvenanceNodeDTO.

Return type:

str

property millis

Gets the millis of this ProvenanceNodeDTO. The timestamp of the node in milliseconds.

Returns:

The millis of this ProvenanceNodeDTO.

Return type:

int

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

property timestamp

Gets the timestamp of this ProvenanceNodeDTO. The timestamp of the node formatted.

Returns:

The timestamp of this ProvenanceNodeDTO.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ProvenanceNodeDTO. The type of the node.

Returns:

The type of this ProvenanceNodeDTO.

Return type:

str

class nipyapi.nifi.models.ProvenanceOptionsDTO(searchable_fields=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(searchable_fields=None)

ProvenanceOptionsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'searchable_fields': 'searchableFields'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceOptionsEntity(provenance_options=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(provenance_options=None)

ProvenanceOptionsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'provenance_options': 'provenanceOptions'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceRequestDTO(cluster_node_id=None, end_date=None, incremental_results=None, max_results=None, maximum_file_size=None, minimum_file_size=None, search_terms=None, start_date=None, summarize=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(cluster_node_id=None, end_date=None, incremental_results=None, max_results=None, maximum_file_size=None, minimum_file_size=None, search_terms=None, start_date=None, summarize=None)

ProvenanceRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property 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

property 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

property 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

property 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, ProvenanceSearchValueDTO)

property 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

property 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, ProvenanceSearchValueDTO)', 'start_date': 'str', 'summarize': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ProvenanceResultsDTO(errors=None, generated=None, oldest_event=None, provenance_events=None, time_offset=None, total=None, total_count=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(errors=None, generated=None, oldest_event=None, provenance_events=None, time_offset=None, total=None, total_count=None)

ProvenanceResultsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'errors': 'errors', 'generated': 'generated', 'oldest_event': 'oldestEvent', 'provenance_events': 'provenanceEvents', 'time_offset': 'timeOffset', 'total': 'total', 'total_count': 'totalCount'}

property 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]

property generated

Gets the generated of this ProvenanceResultsDTO. Then the search was performed.

Returns:

The generated of this ProvenanceResultsDTO.

Return type:

str

property 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

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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total

Gets the total of this ProvenanceResultsDTO. The total number of results formatted.

Returns:

The total of this ProvenanceResultsDTO.

Return type:

str

property total_count

Gets the total_count of this ProvenanceResultsDTO. The total number of results.

Returns:

The total_count of this ProvenanceResultsDTO.

Return type:

int

class nipyapi.nifi.models.ProvenanceSearchValueDTO(inverse=None, value=None)

Bases: object

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

ProvenanceSearchValueDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(inverse=None, value=None)

ProvenanceSearchValueDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'inverse': 'inverse', 'value': 'value'}

property inverse

Gets the inverse of this ProvenanceSearchValueDTO. Query for all except for search value.

Returns:

The inverse of this ProvenanceSearchValueDTO.

Return type:

bool

swagger_types = {'inverse': 'bool', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this ProvenanceSearchValueDTO. The search value.

Returns:

The value of this ProvenanceSearchValueDTO.

Return type:

str

class nipyapi.nifi.models.ProvenanceSearchableFieldDTO(field=None, id=None, label=None, type=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(field=None, id=None, label=None, type=None)

ProvenanceSearchableFieldDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'field': 'field', 'id': 'id', 'label': 'label', 'type': 'type'}

property field

Gets the field of this ProvenanceSearchableFieldDTO. The searchable field.

Returns:

The field of this ProvenanceSearchableFieldDTO.

Return type:

str

property id

Gets the id of this ProvenanceSearchableFieldDTO. The id of the searchable field.

Returns:

The id of this ProvenanceSearchableFieldDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ProvenanceSearchableFieldDTO. The type of the searchable field.

Returns:

The type of this ProvenanceSearchableFieldDTO.

Return type:

str

class nipyapi.nifi.models.QueueSizeDTO(byte_count=None, object_count=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(byte_count=None, object_count=None)

QueueSizeDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'byte_count': 'byteCount', 'object_count': 'objectCount'}

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RegisteredFlow(branch=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, last_modified_timestamp=None, name=None, permissions=None, version_count=None, version_info=None)

Bases: object

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

RegisteredFlow - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(branch=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, last_modified_timestamp=None, name=None, permissions=None, version_count=None, version_info=None)

RegisteredFlow - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'branch': 'branch', 'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'last_modified_timestamp': 'lastModifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'version_count': 'versionCount', 'version_info': 'versionInfo'}

property branch

Gets the branch of this RegisteredFlow.

Returns:

The branch of this RegisteredFlow.

Return type:

str

property bucket_identifier

Gets the bucket_identifier of this RegisteredFlow.

Returns:

The bucket_identifier of this RegisteredFlow.

Return type:

str

property bucket_name

Gets the bucket_name of this RegisteredFlow.

Returns:

The bucket_name of this RegisteredFlow.

Return type:

str

property created_timestamp

Gets the created_timestamp of this RegisteredFlow.

Returns:

The created_timestamp of this RegisteredFlow.

Return type:

int

property description

Gets the description of this RegisteredFlow.

Returns:

The description of this RegisteredFlow.

Return type:

str

property identifier

Gets the identifier of this RegisteredFlow.

Returns:

The identifier of this RegisteredFlow.

Return type:

str

property last_modified_timestamp

Gets the last_modified_timestamp of this RegisteredFlow.

Returns:

The last_modified_timestamp of this RegisteredFlow.

Return type:

int

property name

Gets the name of this RegisteredFlow.

Returns:

The name of this RegisteredFlow.

Return type:

str

property permissions

Gets the permissions of this RegisteredFlow.

Returns:

The permissions of this RegisteredFlow.

Return type:

FlowRegistryPermissions

swagger_types = {'branch': 'str', 'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'last_modified_timestamp': 'int', 'name': 'str', 'permissions': 'FlowRegistryPermissions', 'version_count': 'int', 'version_info': 'RegisteredFlowVersionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version_count

Gets the version_count of this RegisteredFlow.

Returns:

The version_count of this RegisteredFlow.

Return type:

int

property version_info

Gets the version_info of this RegisteredFlow.

Returns:

The version_info of this RegisteredFlow.

Return type:

RegisteredFlowVersionInfo

class nipyapi.nifi.models.RegisteredFlowSnapshot(bucket=None, external_controller_services=None, flow=None, flow_contents=None, flow_encoding_version=None, latest=None, parameter_contexts=None, parameter_providers=None, snapshot_metadata=None)

Bases: object

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

RegisteredFlowSnapshot - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket=None, external_controller_services=None, flow=None, flow_contents=None, flow_encoding_version=None, latest=None, parameter_contexts=None, parameter_providers=None, snapshot_metadata=None)

RegisteredFlowSnapshot - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bucket': 'bucket', 'external_controller_services': 'externalControllerServices', 'flow': 'flow', 'flow_contents': 'flowContents', 'flow_encoding_version': 'flowEncodingVersion', 'latest': 'latest', 'parameter_contexts': 'parameterContexts', 'parameter_providers': 'parameterProviders', 'snapshot_metadata': 'snapshotMetadata'}

property bucket

Gets the bucket of this RegisteredFlowSnapshot.

Returns:

The bucket of this RegisteredFlowSnapshot.

Return type:

FlowRegistryBucket

property external_controller_services

Gets the external_controller_services of this RegisteredFlowSnapshot.

Returns:

The external_controller_services of this RegisteredFlowSnapshot.

Return type:

dict(str, ExternalControllerServiceReference)

property flow

Gets the flow of this RegisteredFlowSnapshot.

Returns:

The flow of this RegisteredFlowSnapshot.

Return type:

RegisteredFlow

property flow_contents

Gets the flow_contents of this RegisteredFlowSnapshot.

Returns:

The flow_contents of this RegisteredFlowSnapshot.

Return type:

VersionedProcessGroup

property flow_encoding_version

Gets the flow_encoding_version of this RegisteredFlowSnapshot.

Returns:

The flow_encoding_version of this RegisteredFlowSnapshot.

Return type:

str

property latest

Gets the latest of this RegisteredFlowSnapshot.

Returns:

The latest of this RegisteredFlowSnapshot.

Return type:

bool

property parameter_contexts

Gets the parameter_contexts of this RegisteredFlowSnapshot.

Returns:

The parameter_contexts of this RegisteredFlowSnapshot.

Return type:

dict(str, VersionedParameterContext)

property parameter_providers

Gets the parameter_providers of this RegisteredFlowSnapshot.

Returns:

The parameter_providers of this RegisteredFlowSnapshot.

Return type:

dict(str, ParameterProviderReference)

property snapshot_metadata

Gets the snapshot_metadata of this RegisteredFlowSnapshot.

Returns:

The snapshot_metadata of this RegisteredFlowSnapshot.

Return type:

RegisteredFlowSnapshotMetadata

swagger_types = {'bucket': 'FlowRegistryBucket', 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', 'flow': 'RegisteredFlow', 'flow_contents': 'VersionedProcessGroup', 'flow_encoding_version': 'str', 'latest': 'bool', 'parameter_contexts': 'dict(str, VersionedParameterContext)', 'parameter_providers': 'dict(str, ParameterProviderReference)', 'snapshot_metadata': 'RegisteredFlowSnapshotMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RegisteredFlowSnapshotMetadata(author=None, branch=None, bucket_identifier=None, comments=None, flow_identifier=None, flow_name=None, registry_identifier=None, registry_name=None, timestamp=None, version=None)

Bases: object

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

RegisteredFlowSnapshotMetadata - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(author=None, branch=None, bucket_identifier=None, comments=None, flow_identifier=None, flow_name=None, registry_identifier=None, registry_name=None, timestamp=None, version=None)

RegisteredFlowSnapshotMetadata - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'author': 'author', 'branch': 'branch', 'bucket_identifier': 'bucketIdentifier', 'comments': 'comments', 'flow_identifier': 'flowIdentifier', 'flow_name': 'flowName', 'registry_identifier': 'registryIdentifier', 'registry_name': 'registryName', 'timestamp': 'timestamp', 'version': 'version'}

property author

Gets the author of this RegisteredFlowSnapshotMetadata.

Returns:

The author of this RegisteredFlowSnapshotMetadata.

Return type:

str

property branch

Gets the branch of this RegisteredFlowSnapshotMetadata.

Returns:

The branch of this RegisteredFlowSnapshotMetadata.

Return type:

str

property bucket_identifier

Gets the bucket_identifier of this RegisteredFlowSnapshotMetadata.

Returns:

The bucket_identifier of this RegisteredFlowSnapshotMetadata.

Return type:

str

property comments

Gets the comments of this RegisteredFlowSnapshotMetadata.

Returns:

The comments of this RegisteredFlowSnapshotMetadata.

Return type:

str

property flow_identifier

Gets the flow_identifier of this RegisteredFlowSnapshotMetadata.

Returns:

The flow_identifier of this RegisteredFlowSnapshotMetadata.

Return type:

str

property flow_name

Gets the flow_name of this RegisteredFlowSnapshotMetadata.

Returns:

The flow_name of this RegisteredFlowSnapshotMetadata.

Return type:

str

property registry_identifier

Gets the registry_identifier of this RegisteredFlowSnapshotMetadata.

Returns:

The registry_identifier of this RegisteredFlowSnapshotMetadata.

Return type:

str

property registry_name

Gets the registry_name of this RegisteredFlowSnapshotMetadata.

Returns:

The registry_name of this RegisteredFlowSnapshotMetadata.

Return type:

str

swagger_types = {'author': 'str', 'branch': 'str', 'bucket_identifier': 'str', 'comments': 'str', 'flow_identifier': 'str', 'flow_name': 'str', 'registry_identifier': 'str', 'registry_name': 'str', 'timestamp': 'int', 'version': 'str'}

property timestamp

Gets the timestamp of this RegisteredFlowSnapshotMetadata.

Returns:

The timestamp of this RegisteredFlowSnapshotMetadata.

Return type:

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this RegisteredFlowSnapshotMetadata.

Returns:

The version of this RegisteredFlowSnapshotMetadata.

Return type:

str

class nipyapi.nifi.models.RegisteredFlowVersionInfo(version=None)

Bases: object

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

RegisteredFlowVersionInfo - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(version=None)

RegisteredFlowVersionInfo - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'version': 'version'}

swagger_types = {'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this RegisteredFlowVersionInfo.

Returns:

The version of this RegisteredFlowVersionInfo.

Return type:

int

class nipyapi.nifi.models.Relationship(description=None, name=None)

Bases: object

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

Relationship - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None)

Relationship - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this Relationship. The description of the relationship

Returns:

The description of this Relationship.

Return type:

str

property name

Gets the name of this Relationship. The name of the relationship

Returns:

The name of this Relationship.

Return type:

str

swagger_types = {'description': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RelationshipDTO(auto_terminate=None, description=None, name=None, retry=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(auto_terminate=None, description=None, name=None, retry=None)

RelationshipDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'auto_terminate': 'autoTerminate', 'description': 'description', 'name': 'name', 'retry': 'retry'}

property 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

property description

Gets the description of this RelationshipDTO. The relationship description.

Returns:

The description of this RelationshipDTO.

Return type:

str

property name

Gets the name of this RelationshipDTO. The relationship name.

Returns:

The name of this RelationshipDTO.

Return type:

str

property retry

Gets the retry of this RelationshipDTO. Whether or not flowfiles sent to this relationship should retry.

Returns:

The retry of this RelationshipDTO.

Return type:

bool

swagger_types = {'auto_terminate': 'bool', 'description': 'str', 'name': 'str', 'retry': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RemotePortRunStatusEntity(disconnected_node_acknowledged=None, revision=None, state=None)

Bases: object

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

RemotePortRunStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, revision=None, state=None)

RemotePortRunStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision', 'state': 'state'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this RemotePortRunStatusEntity.

Return type:

bool

property revision

Gets the revision of this RemotePortRunStatusEntity.

Returns:

The revision of this RemotePortRunStatusEntity.

Return type:

RevisionDTO

property state

Gets the state of this RemotePortRunStatusEntity. The run status of the RemotePort.

Returns:

The state of this RemotePortRunStatusEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RemoteProcessGroupContentsDTO(input_ports=None, output_ports=None)

Bases: object

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

RemoteProcessGroupContentsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(input_ports=None, output_ports=None)

RemoteProcessGroupContentsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'input_ports': 'inputPorts', 'output_ports': 'outputPorts'}

property 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]

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RemoteProcessGroupDTO(active_remote_input_port_count=None, active_remote_output_port_count=None, authorization_issues=None, comments=None, communications_timeout=None, contents=None, flow_refreshed=None, id=None, inactive_remote_input_port_count=None, inactive_remote_output_port_count=None, input_port_count=None, local_network_interface=None, name=None, output_port_count=None, parent_group_id=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_secure=None, target_uri=None, target_uris=None, transmitting=None, transport_protocol=None, validation_errors=None, versioned_component_id=None, yield_duration=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(active_remote_input_port_count=None, active_remote_output_port_count=None, authorization_issues=None, comments=None, communications_timeout=None, contents=None, flow_refreshed=None, id=None, inactive_remote_input_port_count=None, inactive_remote_output_port_count=None, input_port_count=None, local_network_interface=None, name=None, output_port_count=None, parent_group_id=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_secure=None, target_uri=None, target_uris=None, transmitting=None, transport_protocol=None, validation_errors=None, versioned_component_id=None, yield_duration=None)

RemoteProcessGroupDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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

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

property 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]

property comments

Gets the comments of this RemoteProcessGroupDTO. The comments for the remote process group.

Returns:

The comments of this RemoteProcessGroupDTO.

Return type:

str

property 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

property contents

Gets the contents of this RemoteProcessGroupDTO.

Returns:

The contents of this RemoteProcessGroupDTO.

Return type:

RemoteProcessGroupContentsDTO

property 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

property id

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

Returns:

The id of this RemoteProcessGroupDTO.

Return type:

str

property 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

property 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

property 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

property 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

property name

Gets the name of this RemoteProcessGroupDTO. The name of the remote process group.

Returns:

The name of this RemoteProcessGroupDTO.

Return type:

str

property 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

property 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

property position

Gets the position of this RemoteProcessGroupDTO.

Returns:

The position of this RemoteProcessGroupDTO.

Return type:

PositionDTO

property proxy_host

Gets the proxy_host of this RemoteProcessGroupDTO.

Returns:

The proxy_host of this RemoteProcessGroupDTO.

Return type:

str

property proxy_password

Gets the proxy_password of this RemoteProcessGroupDTO.

Returns:

The proxy_password of this RemoteProcessGroupDTO.

Return type:

str

property proxy_port

Gets the proxy_port of this RemoteProcessGroupDTO.

Returns:

The proxy_port of this RemoteProcessGroupDTO.

Return type:

int

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

property 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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property transmitting

Gets the transmitting of this RemoteProcessGroupDTO. Whether the remote process group is actively transmitting.

Returns:

The transmitting of this RemoteProcessGroupDTO.

Return type:

bool

property transport_protocol

Gets the transport_protocol of this RemoteProcessGroupDTO.

Returns:

The transport_protocol of this RemoteProcessGroupDTO.

Return type:

str

property 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]

property 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

property 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

class nipyapi.nifi.models.RemoteProcessGroupEntity(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, input_port_count=None, operate_permissions=None, output_port_count=None, permissions=None, position=None, revision=None, status=None, uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, input_port_count=None, operate_permissions=None, output_port_count=None, permissions=None, position=None, revision=None, status=None, uri=None)

RemoteProcessGroupEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this RemoteProcessGroupEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this RemoteProcessGroupEntity.

Returns:

The component of this RemoteProcessGroupEntity.

Return type:

RemoteProcessGroupDTO

property 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

property id

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

Returns:

The id of this RemoteProcessGroupEntity.

Return type:

str

property 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

property operate_permissions

Gets the operate_permissions of this RemoteProcessGroupEntity.

Returns:

The operate_permissions of this RemoteProcessGroupEntity.

Return type:

PermissionsDTO

property 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

property permissions

Gets the permissions of this RemoteProcessGroupEntity.

Returns:

The permissions of this RemoteProcessGroupEntity.

Return type:

PermissionsDTO

property position

Gets the position of this RemoteProcessGroupEntity.

Returns:

The position of this RemoteProcessGroupEntity.

Return type:

PositionDTO

property revision

Gets the revision of this RemoteProcessGroupEntity.

Returns:

The revision of this RemoteProcessGroupEntity.

Return type:

RevisionDTO

property status

Gets the status of this RemoteProcessGroupEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this RemoteProcessGroupEntity.

Return type:

str

class nipyapi.nifi.models.RemoteProcessGroupPortDTO(batch_settings=None, comments=None, concurrently_schedulable_task_count=None, connected=None, exists=None, group_id=None, id=None, name=None, target_id=None, target_running=None, transmitting=None, use_compression=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(batch_settings=None, comments=None, concurrently_schedulable_task_count=None, connected=None, exists=None, group_id=None, id=None, name=None, target_id=None, target_running=None, transmitting=None, use_compression=None, versioned_component_id=None)

RemoteProcessGroupPortDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property batch_settings

Gets the batch_settings of this RemoteProcessGroupPortDTO.

Returns:

The batch_settings of this RemoteProcessGroupPortDTO.

Return type:

BatchSettingsDTO

property comments

Gets the comments of this RemoteProcessGroupPortDTO. The comments as configured on the target port.

Returns:

The comments of this RemoteProcessGroupPortDTO.

Return type:

str

property 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

property 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

property exists

Gets the exists of this RemoteProcessGroupPortDTO. Whether the target port exists.

Returns:

The exists of this RemoteProcessGroupPortDTO.

Return type:

bool

property 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

property id

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

Returns:

The id of this RemoteProcessGroupPortDTO.

Return type:

str

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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property transmitting

Gets the transmitting of this RemoteProcessGroupPortDTO. Whether the remote port is configured for transmission.

Returns:

The transmitting of this RemoteProcessGroupPortDTO.

Return type:

bool

property 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

property 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

class nipyapi.nifi.models.RemoteProcessGroupPortEntity(bulletins=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, remote_process_group_port=None, revision=None, uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, remote_process_group_port=None, revision=None, uri=None)

RemoteProcessGroupPortEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this RemoteProcessGroupPortEntity.

Return type:

list[BulletinEntity]

property 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

property id

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

Returns:

The id of this RemoteProcessGroupPortEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this RemoteProcessGroupPortEntity.

Returns:

The operate_permissions of this RemoteProcessGroupPortEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this RemoteProcessGroupPortEntity.

Returns:

The permissions of this RemoteProcessGroupPortEntity.

Return type:

PermissionsDTO

property position

Gets the position of this RemoteProcessGroupPortEntity.

Returns:

The position of this RemoteProcessGroupPortEntity.

Return type:

PositionDTO

property 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

property revision

Gets the revision of this RemoteProcessGroupPortEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this RemoteProcessGroupPortEntity.

Return type:

str

class nipyapi.nifi.models.RemoteProcessGroupStatusDTO(aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, stats_last_refreshed=None, target_uri=None, transmission_status=None, validation_status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, group_id=None, id=None, name=None, node_snapshots=None, stats_last_refreshed=None, target_uri=None, transmission_status=None, validation_status=None)

RemoteProcessGroupStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this RemoteProcessGroupStatusDTO.

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

property 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

property id

Gets the id of this RemoteProcessGroupStatusDTO. The unique ID of the Processor

Returns:

The id of this RemoteProcessGroupStatusDTO.

Return type:

str

property name

Gets the name of this RemoteProcessGroupStatusDTO. The name of the remote process group.

Returns:

The name of this RemoteProcessGroupStatusDTO.

Return type:

str

property 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]

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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property 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

class nipyapi.nifi.models.RemoteProcessGroupStatusEntity(can_read=None, remote_process_group_status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, remote_process_group_status=None)

RemoteProcessGroupStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'remote_process_group_status': 'remoteProcessGroupStatus'}

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RemoteProcessGroupStatusSnapshotDTO(active_thread_count=None, bytes_received=None, bytes_sent=None, flow_files_received=None, flow_files_sent=None, group_id=None, id=None, name=None, received=None, sent=None, target_uri=None, transmission_status=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, bytes_received=None, bytes_sent=None, flow_files_received=None, flow_files_sent=None, group_id=None, id=None, name=None, received=None, sent=None, target_uri=None, transmission_status=None)

RemoteProcessGroupStatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property 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

property 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

property id

Gets the id of this RemoteProcessGroupStatusSnapshotDTO. The id of the remote process group.

Returns:

The id of this RemoteProcessGroupStatusSnapshotDTO.

Return type:

str

property name

Gets the name of this RemoteProcessGroupStatusSnapshotDTO. The name of the remote process group.

Returns:

The name of this RemoteProcessGroupStatusSnapshotDTO.

Return type:

str

property 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

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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.RemoteProcessGroupStatusSnapshotEntity(can_read=None, id=None, remote_process_group_status_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, id=None, remote_process_group_status_snapshot=None)

RemoteProcessGroupStatusSnapshotEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'id': 'id', 'remote_process_group_status_snapshot': 'remoteProcessGroupStatusSnapshot'}

property 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

property id

Gets the id of this RemoteProcessGroupStatusSnapshotEntity. The id of the remote process group.

Returns:

The id of this RemoteProcessGroupStatusSnapshotEntity.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RemoteProcessGroupsEntity(remote_process_groups=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(remote_process_groups=None)

RemoteProcessGroupsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'remote_process_groups': 'remoteProcessGroups'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ReplayLastEventRequestEntity(component_id=None, nodes=None)

Bases: object

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

ReplayLastEventRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(component_id=None, nodes=None)

ReplayLastEventRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'component_id': 'componentId', 'nodes': 'nodes'}

property component_id

Gets the component_id of this ReplayLastEventRequestEntity. The UUID of the component whose last event should be replayed.

Returns:

The component_id of this ReplayLastEventRequestEntity.

Return type:

str

property nodes

Gets the nodes of this ReplayLastEventRequestEntity. Which nodes are to replay their last provenance event.

Returns:

The nodes of this ReplayLastEventRequestEntity.

Return type:

str

swagger_types = {'component_id': 'str', 'nodes': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ReplayLastEventResponseEntity(aggregate_snapshot=None, component_id=None, node_snapshots=None, nodes=None)

Bases: object

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

ReplayLastEventResponseEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, component_id=None, node_snapshots=None, nodes=None)

ReplayLastEventResponseEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this ReplayLastEventResponseEntity.

Returns:

The aggregate_snapshot of this ReplayLastEventResponseEntity.

Return type:

ReplayLastEventSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'component_id': 'componentId', 'node_snapshots': 'nodeSnapshots', 'nodes': 'nodes'}

property component_id

Gets the component_id of this ReplayLastEventResponseEntity. The UUID of the component whose last event should be replayed.

Returns:

The component_id of this ReplayLastEventResponseEntity.

Return type:

str

property node_snapshots

Gets the node_snapshots of this ReplayLastEventResponseEntity. The node-wise results

Returns:

The node_snapshots of this ReplayLastEventResponseEntity.

Return type:

list[NodeReplayLastEventSnapshotDTO]

property nodes

Gets the nodes of this ReplayLastEventResponseEntity. Which nodes were requested to replay their last provenance event.

Returns:

The nodes of this ReplayLastEventResponseEntity.

Return type:

str

swagger_types = {'aggregate_snapshot': 'ReplayLastEventSnapshotDTO', 'component_id': 'str', 'node_snapshots': 'list[NodeReplayLastEventSnapshotDTO]', 'nodes': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ReplayLastEventSnapshotDTO(event_available=None, events_replayed=None, failure_explanation=None)

Bases: object

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

ReplayLastEventSnapshotDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(event_available=None, events_replayed=None, failure_explanation=None)

ReplayLastEventSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'event_available': 'eventAvailable', 'events_replayed': 'eventsReplayed', 'failure_explanation': 'failureExplanation'}

property event_available

Gets the event_available of this ReplayLastEventSnapshotDTO. Whether or not an event was available. This may not be populated if there was a failure.

Returns:

The event_available of this ReplayLastEventSnapshotDTO.

Return type:

bool

property events_replayed

Gets the events_replayed of this ReplayLastEventSnapshotDTO. The IDs of the events that were successfully replayed

Returns:

The events_replayed of this ReplayLastEventSnapshotDTO.

Return type:

list[int]

property failure_explanation

Gets the failure_explanation of this ReplayLastEventSnapshotDTO. If unable to replay an event, specifies why the event could not be replayed

Returns:

The failure_explanation of this ReplayLastEventSnapshotDTO.

Return type:

str

swagger_types = {'event_available': 'bool', 'events_replayed': 'list[int]', 'failure_explanation': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ReportingTaskDTO(active_thread_count=None, annotation_data=None, bundle=None, comments=None, custom_ui_url=None, default_scheduling_period=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, restricted=None, scheduling_period=None, scheduling_strategy=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, annotation_data=None, bundle=None, comments=None, custom_ui_url=None, default_scheduling_period=None, deprecated=None, descriptors=None, extension_missing=None, id=None, multiple_versions_available=None, name=None, parent_group_id=None, persists_state=None, position=None, properties=None, restricted=None, scheduling_period=None, scheduling_strategy=None, sensitive_dynamic_property_names=None, state=None, supports_sensitive_dynamic_properties=None, type=None, validation_errors=None, validation_status=None, versioned_component_id=None)

ReportingTaskDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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

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

property bundle

Gets the bundle of this ReportingTaskDTO.

Returns:

The bundle of this ReportingTaskDTO.

Return type:

BundleDTO

property comments

Gets the comments of this ReportingTaskDTO. The comments of the reporting task.

Returns:

The comments of this ReportingTaskDTO.

Return type:

str

property 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

property 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)

property deprecated

Gets the deprecated of this ReportingTaskDTO. Whether the reporting task has been deprecated.

Returns:

The deprecated of this ReportingTaskDTO.

Return type:

bool

property 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)

property 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

property id

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

Returns:

The id of this ReportingTaskDTO.

Return type:

str

property 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

property name

Gets the name of this ReportingTaskDTO. The name of the reporting task.

Returns:

The name of this ReportingTaskDTO.

Return type:

str

property 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

property 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

property position

Gets the position of this ReportingTaskDTO.

Returns:

The position of this ReportingTaskDTO.

Return type:

PositionDTO

property properties

Gets the properties of this ReportingTaskDTO. The properties of the reporting task.

Returns:

The properties of this ReportingTaskDTO.

Return type:

dict(str, str)

property restricted

Gets the restricted of this ReportingTaskDTO. Whether the reporting task requires elevated privileges.

Returns:

The restricted of this ReportingTaskDTO.

Return type:

bool

property scheduling_period

Gets the scheduling_period of this ReportingTaskDTO. The frequency with which to schedule the reporting task. The format of the value will depend on the value of the schedulingStrategy.

Returns:

The scheduling_period of this ReportingTaskDTO.

Return type:

str

property 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

property sensitive_dynamic_property_names

Gets the sensitive_dynamic_property_names of this ReportingTaskDTO. Set of sensitive dynamic property names

Returns:

The sensitive_dynamic_property_names of this ReportingTaskDTO.

Return type:

list[str]

property state

Gets the state of this ReportingTaskDTO. The state of the reporting task.

Returns:

The state of this ReportingTaskDTO.

Return type:

str

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ReportingTaskDTO. Whether the reporting task supports sensitive dynamic properties.

Returns:

The supports_sensitive_dynamic_properties of this ReportingTaskDTO.

Return type:

bool

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', 'sensitive_dynamic_property_names': 'list[str]', 'state': 'str', 'supports_sensitive_dynamic_properties': 'bool', 'type': 'str', 'validation_errors': 'list[str]', 'validation_status': 'str', 'versioned_component_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ReportingTaskDTO. The fully qualified type of the reporting task.

Returns:

The type of this ReportingTaskDTO.

Return type:

str

property 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]

property validation_status

Gets the validation_status of this ReportingTaskDTO. Indicates whether the Reporting Task is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Reporting Task is valid)

Returns:

The validation_status of this ReportingTaskDTO.

Return type:

str

property 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

class nipyapi.nifi.models.ReportingTaskDefinition(additional_details=None, artifact=None, build_info=None, default_scheduling_period_by_scheduling_strategy=None, default_scheduling_strategy=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supported_scheduling_strategies=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

Bases: object

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

ReportingTaskDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(additional_details=None, artifact=None, build_info=None, default_scheduling_period_by_scheduling_strategy=None, default_scheduling_strategy=None, deprecated=None, deprecation_alternatives=None, deprecation_reason=None, dynamic_properties=None, explicit_restrictions=None, group=None, property_descriptors=None, provided_api_implementations=None, restricted=None, restricted_explanation=None, see_also=None, stateful=None, supported_scheduling_strategies=None, supports_dynamic_properties=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, type=None, type_description=None, version=None)

ReportingTaskDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property additional_details

Gets the additional_details of this ReportingTaskDefinition. Indicates if the component has additional details documentation

Returns:

The additional_details of this ReportingTaskDefinition.

Return type:

bool

property artifact

Gets the artifact of this ReportingTaskDefinition. The artifact name of the bundle that provides the referenced type.

Returns:

The artifact of this ReportingTaskDefinition.

Return type:

str

attribute_map = {'additional_details': 'additionalDetails', 'artifact': 'artifact', 'build_info': 'buildInfo', 'default_scheduling_period_by_scheduling_strategy': 'defaultSchedulingPeriodBySchedulingStrategy', 'default_scheduling_strategy': 'defaultSchedulingStrategy', 'deprecated': 'deprecated', 'deprecation_alternatives': 'deprecationAlternatives', 'deprecation_reason': 'deprecationReason', 'dynamic_properties': 'dynamicProperties', 'explicit_restrictions': 'explicitRestrictions', 'group': 'group', 'property_descriptors': 'propertyDescriptors', 'provided_api_implementations': 'providedApiImplementations', 'restricted': 'restricted', 'restricted_explanation': 'restrictedExplanation', 'see_also': 'seeAlso', 'stateful': 'stateful', 'supported_scheduling_strategies': 'supportedSchedulingStrategies', 'supports_dynamic_properties': 'supportsDynamicProperties', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'system_resource_considerations': 'systemResourceConsiderations', 'tags': 'tags', 'type': 'type', 'type_description': 'typeDescription', 'version': 'version'}

property build_info

Gets the build_info of this ReportingTaskDefinition.

Returns:

The build_info of this ReportingTaskDefinition.

Return type:

BuildInfo

property default_scheduling_period_by_scheduling_strategy

Gets the default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition. The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as “30 sec”.

Returns:

The default_scheduling_period_by_scheduling_strategy of this ReportingTaskDefinition.

Return type:

dict(str, str)

property default_scheduling_strategy

Gets the default_scheduling_strategy of this ReportingTaskDefinition. The default scheduling strategy for the reporting task.

Returns:

The default_scheduling_strategy of this ReportingTaskDefinition.

Return type:

str

property deprecated

Gets the deprecated of this ReportingTaskDefinition. Whether or not the component has been deprecated

Returns:

The deprecated of this ReportingTaskDefinition.

Return type:

bool

property deprecation_alternatives

Gets the deprecation_alternatives of this ReportingTaskDefinition. If this component has been deprecated, this optional field provides alternatives to use

Returns:

The deprecation_alternatives of this ReportingTaskDefinition.

Return type:

list[str]

property deprecation_reason

Gets the deprecation_reason of this ReportingTaskDefinition. If this component has been deprecated, this optional field can be used to provide an explanation

Returns:

The deprecation_reason of this ReportingTaskDefinition.

Return type:

str

property dynamic_properties

Gets the dynamic_properties of this ReportingTaskDefinition. Describes the dynamic properties supported by this component

Returns:

The dynamic_properties of this ReportingTaskDefinition.

Return type:

list[DynamicProperty]

property explicit_restrictions

Gets the explicit_restrictions of this ReportingTaskDefinition. Explicit restrictions that indicate a require permission to use the component

Returns:

The explicit_restrictions of this ReportingTaskDefinition.

Return type:

list[Restriction]

property group

Gets the group of this ReportingTaskDefinition. The group name of the bundle that provides the referenced type.

Returns:

The group of this ReportingTaskDefinition.

Return type:

str

property property_descriptors

Gets the property_descriptors of this ReportingTaskDefinition. Descriptions of configuration properties applicable to this component.

Returns:

The property_descriptors of this ReportingTaskDefinition.

Return type:

dict(str, PropertyDescriptor)

property provided_api_implementations

Gets the provided_api_implementations of this ReportingTaskDefinition. If this type represents a provider for an interface, this lists the APIs it implements

Returns:

The provided_api_implementations of this ReportingTaskDefinition.

Return type:

list[DefinedType]

property restricted

Gets the restricted of this ReportingTaskDefinition. Whether or not the component has a general restriction

Returns:

The restricted of this ReportingTaskDefinition.

Return type:

bool

property restricted_explanation

Gets the restricted_explanation of this ReportingTaskDefinition. An optional description of the general restriction

Returns:

The restricted_explanation of this ReportingTaskDefinition.

Return type:

str

property see_also

Gets the see_also of this ReportingTaskDefinition. The names of other component types that may be related

Returns:

The see_also of this ReportingTaskDefinition.

Return type:

list[str]

property stateful

Gets the stateful of this ReportingTaskDefinition.

Returns:

The stateful of this ReportingTaskDefinition.

Return type:

Stateful

property supported_scheduling_strategies

Gets the supported_scheduling_strategies of this ReportingTaskDefinition. The supported scheduling strategies, such as TIME_DRIVER or CRON.

Returns:

The supported_scheduling_strategies of this ReportingTaskDefinition.

Return type:

list[str]

property supports_dynamic_properties

Gets the supports_dynamic_properties of this ReportingTaskDefinition. Whether or not this component makes use of dynamic (user-set) properties.

Returns:

The supports_dynamic_properties of this ReportingTaskDefinition.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this ReportingTaskDefinition. Whether or not this component makes use of sensitive dynamic (user-set) properties.

Returns:

The supports_sensitive_dynamic_properties of this ReportingTaskDefinition.

Return type:

bool

swagger_types = {'additional_details': 'bool', 'artifact': 'str', 'build_info': 'BuildInfo', 'default_scheduling_period_by_scheduling_strategy': 'dict(str, str)', 'default_scheduling_strategy': 'str', 'deprecated': 'bool', 'deprecation_alternatives': 'list[str]', 'deprecation_reason': 'str', 'dynamic_properties': 'list[DynamicProperty]', 'explicit_restrictions': 'list[Restriction]', 'group': 'str', 'property_descriptors': 'dict(str, PropertyDescriptor)', 'provided_api_implementations': 'list[DefinedType]', 'restricted': 'bool', 'restricted_explanation': 'str', 'see_also': 'list[str]', 'stateful': 'Stateful', 'supported_scheduling_strategies': 'list[str]', 'supports_dynamic_properties': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'system_resource_considerations': 'list[SystemResourceConsideration]', 'tags': 'list[str]', 'type': 'str', 'type_description': 'str', 'version': 'str'}

property system_resource_considerations

Gets the system_resource_considerations of this ReportingTaskDefinition. The system resource considerations for the given component

Returns:

The system_resource_considerations of this ReportingTaskDefinition.

Return type:

list[SystemResourceConsideration]

property tags

Gets the tags of this ReportingTaskDefinition. The tags associated with this type

Returns:

The tags of this ReportingTaskDefinition.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ReportingTaskDefinition. The fully-qualified class type

Returns:

The type of this ReportingTaskDefinition.

Return type:

str

property type_description

Gets the type_description of this ReportingTaskDefinition. The description of the type.

Returns:

The type_description of this ReportingTaskDefinition.

Return type:

str

property version

Gets the version of this ReportingTaskDefinition. The version of the bundle that provides the referenced type.

Returns:

The version of this ReportingTaskDefinition.

Return type:

str

class nipyapi.nifi.models.ReportingTaskEntity(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, operate_permissions=None, permissions=None, position=None, revision=None, status=None, uri=None)

ReportingTaskEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this ReportingTaskEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this ReportingTaskEntity.

Returns:

The component of this ReportingTaskEntity.

Return type:

ReportingTaskDTO

property 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

property id

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

Returns:

The id of this ReportingTaskEntity.

Return type:

str

property operate_permissions

Gets the operate_permissions of this ReportingTaskEntity.

Returns:

The operate_permissions of this ReportingTaskEntity.

Return type:

PermissionsDTO

property permissions

Gets the permissions of this ReportingTaskEntity.

Returns:

The permissions of this ReportingTaskEntity.

Return type:

PermissionsDTO

property position

Gets the position of this ReportingTaskEntity.

Returns:

The position of this ReportingTaskEntity.

Return type:

PositionDTO

property revision

Gets the revision of this ReportingTaskEntity.

Returns:

The revision of this ReportingTaskEntity.

Return type:

RevisionDTO

property status

Gets the status of this ReportingTaskEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this ReportingTaskEntity.

Return type:

str

class nipyapi.nifi.models.ReportingTaskRunStatusEntity(disconnected_node_acknowledged=None, revision=None, state=None)

Bases: object

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

ReportingTaskRunStatusEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, revision=None, state=None)

ReportingTaskRunStatusEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'revision': 'revision', 'state': 'state'}

property disconnected_node_acknowledged

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

Returns:

The disconnected_node_acknowledged of this ReportingTaskRunStatusEntity.

Return type:

bool

property revision

Gets the revision of this ReportingTaskRunStatusEntity.

Returns:

The revision of this ReportingTaskRunStatusEntity.

Return type:

RevisionDTO

property state

Gets the state of this ReportingTaskRunStatusEntity. The run status of the ReportingTask.

Returns:

The state of this ReportingTaskRunStatusEntity.

Return type:

str

swagger_types = {'disconnected_node_acknowledged': 'bool', 'revision': 'RevisionDTO', 'state': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ReportingTaskStatusDTO(active_thread_count=None, run_status=None, validation_status=None)

Bases: object

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

ReportingTaskStatusDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(active_thread_count=None, run_status=None, validation_status=None)

ReportingTaskStatusDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property active_thread_count

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

Returns:

The active_thread_count of this ReportingTaskStatusDTO.

Return type:

int

attribute_map = {'active_thread_count': 'activeThreadCount', 'run_status': 'runStatus', 'validation_status': 'validationStatus'}

property run_status

Gets the run_status of this ReportingTaskStatusDTO. The run status of this ReportingTask

Returns:

The run_status of this ReportingTaskStatusDTO.

Return type:

str

swagger_types = {'active_thread_count': 'int', 'run_status': 'str', 'validation_status': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property validation_status

Gets the validation_status of this ReportingTaskStatusDTO. 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 ReportingTaskStatusDTO.

Return type:

str

class nipyapi.nifi.models.ReportingTaskTypesEntity(reporting_task_types=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(reporting_task_types=None)

ReportingTaskTypesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'reporting_task_types': 'reportingTaskTypes'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ReportingTasksEntity(current_time=None, reporting_tasks=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(current_time=None, reporting_tasks=None)

ReportingTasksEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'current_time': 'currentTime', 'reporting_tasks': 'reportingTasks'}

property current_time

Gets the current_time of this ReportingTasksEntity. The current time on the system.

Returns:

The current_time of this ReportingTasksEntity.

Return type:

str

property reporting_tasks

Gets the reporting_tasks of this ReportingTasksEntity.

Returns:

The reporting_tasks of this ReportingTasksEntity.

Return type:

list[ReportingTaskEntity]

swagger_types = {'current_time': 'str', 'reporting_tasks': 'list[ReportingTaskEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RequiredPermissionDTO(id=None, label=None)

Bases: object

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

RequiredPermissionDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, label=None)

RequiredPermissionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'id': 'id', 'label': 'label'}

property id

Gets the id of this RequiredPermissionDTO. The required sub-permission necessary for this restriction.

Returns:

The id of this RequiredPermissionDTO.

Return type:

str

property label

Gets the label of this RequiredPermissionDTO. The label for the required sub-permission necessary for this restriction.

Returns:

The label of this RequiredPermissionDTO.

Return type:

str

swagger_types = {'id': 'str', 'label': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ResourceClaimDetailsDTO(awaiting_destruction=None, claimant_count=None, container=None, identifier=None, in_use=None, section=None, writable=None)

Bases: object

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

ResourceClaimDetailsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(awaiting_destruction=None, claimant_count=None, container=None, identifier=None, in_use=None, section=None, writable=None)

ResourceClaimDetailsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'awaiting_destruction': 'awaitingDestruction', 'claimant_count': 'claimantCount', 'container': 'container', 'identifier': 'identifier', 'in_use': 'inUse', 'section': 'section', 'writable': 'writable'}

property awaiting_destruction

Gets the awaiting_destruction of this ResourceClaimDetailsDTO. Whether or not the Resource Claim is awaiting destruction

Returns:

The awaiting_destruction of this ResourceClaimDetailsDTO.

Return type:

bool

property claimant_count

Gets the claimant_count of this ResourceClaimDetailsDTO. The number of FlowFiles that have a claim to the Resource

Returns:

The claimant_count of this ResourceClaimDetailsDTO.

Return type:

int

property container

Gets the container of this ResourceClaimDetailsDTO. The container of the Content Repository in which the Resource Claim exists

Returns:

The container of this ResourceClaimDetailsDTO.

Return type:

str

property identifier

Gets the identifier of this ResourceClaimDetailsDTO. The identifier of the Resource Claim

Returns:

The identifier of this ResourceClaimDetailsDTO.

Return type:

str

property in_use

Gets the in_use of this ResourceClaimDetailsDTO. Whether or not the Resource Claim is in use

Returns:

The in_use of this ResourceClaimDetailsDTO.

Return type:

bool

property section

Gets the section of this ResourceClaimDetailsDTO. The section of the Content Repository in which the Resource Claim exists

Returns:

The section of this ResourceClaimDetailsDTO.

Return type:

str

swagger_types = {'awaiting_destruction': 'bool', 'claimant_count': 'int', 'container': 'str', 'identifier': 'str', 'in_use': 'bool', 'section': 'str', 'writable': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property writable

Gets the writable of this ResourceClaimDetailsDTO. Whether or not the Resource Claim can still have more data written to it

Returns:

The writable of this ResourceClaimDetailsDTO.

Return type:

bool

class nipyapi.nifi.models.ResourceDTO(identifier=None, name=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(identifier=None, name=None)

ResourceDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'identifier': 'identifier', 'name': 'name'}

property identifier

Gets the identifier of this ResourceDTO. The identifier of the resource.

Returns:

The identifier of this ResourceDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.ResourcesEntity(resources=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(resources=None)

ResourcesEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'resources': 'resources'}

property resources

Gets the resources of this ResourcesEntity.

Returns:

The resources of this ResourcesEntity.

Return type:

list[ResourceDTO]

swagger_types = {'resources': 'list[ResourceDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.Restriction(explanation=None, required_permission=None)

Bases: object

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

Restriction - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(explanation=None, required_permission=None)

Restriction - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'explanation': 'explanation', 'required_permission': 'requiredPermission'}

property explanation

Gets the explanation of this Restriction. The explanation of this restriction

Returns:

The explanation of this Restriction.

Return type:

str

property required_permission

Gets the required_permission of this Restriction. The permission required for this restriction

Returns:

The required_permission of this Restriction.

Return type:

str

swagger_types = {'explanation': 'str', 'required_permission': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RevisionDTO(client_id=None, last_modifier=None, version=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(client_id=None, last_modifier=None, version=None)

RevisionDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'client_id': 'clientId', 'last_modifier': 'lastModifier', 'version': 'version'}

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.RunStatusDetailsRequestEntity(processor_ids=None)

Bases: object

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

RunStatusDetailsRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(processor_ids=None)

RunStatusDetailsRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'processor_ids': 'processorIds'}

property processor_ids

Gets the processor_ids of this RunStatusDetailsRequestEntity. The IDs of all processors whose run status details should be provided

Returns:

The processor_ids of this RunStatusDetailsRequestEntity.

Return type:

list[str]

swagger_types = {'processor_ids': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.RuntimeManifest(agent_type=None, build_info=None, bundles=None, identifier=None, scheduling_defaults=None, version=None)

Bases: object

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

RuntimeManifest - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(agent_type=None, build_info=None, bundles=None, identifier=None, scheduling_defaults=None, version=None)

RuntimeManifest - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property agent_type

Gets the agent_type of this RuntimeManifest. The type of the runtime binary, e.g., ‘minifi-java’ or ‘minifi-cpp’

Returns:

The agent_type of this RuntimeManifest.

Return type:

str

attribute_map = {'agent_type': 'agentType', 'build_info': 'buildInfo', 'bundles': 'bundles', 'identifier': 'identifier', 'scheduling_defaults': 'schedulingDefaults', 'version': 'version'}

property build_info

Gets the build_info of this RuntimeManifest.

Returns:

The build_info of this RuntimeManifest.

Return type:

BuildInfo

property bundles

Gets the bundles of this RuntimeManifest. All extension bundles included with this runtime

Returns:

The bundles of this RuntimeManifest.

Return type:

list[Bundle]

property identifier

Gets the identifier of this RuntimeManifest. A unique identifier for the manifest

Returns:

The identifier of this RuntimeManifest.

Return type:

str

property scheduling_defaults

Gets the scheduling_defaults of this RuntimeManifest.

Returns:

The scheduling_defaults of this RuntimeManifest.

Return type:

SchedulingDefaults

swagger_types = {'agent_type': 'str', 'build_info': 'BuildInfo', 'bundles': 'list[Bundle]', 'identifier': 'str', 'scheduling_defaults': 'SchedulingDefaults', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this RuntimeManifest. The version of the runtime binary, e.g., ‘1.0.1’

Returns:

The version of this RuntimeManifest.

Return type:

str

class nipyapi.nifi.models.RuntimeManifestEntity(runtime_manifest=None)

Bases: object

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

RuntimeManifestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(runtime_manifest=None)

RuntimeManifestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'runtime_manifest': 'runtimeManifest'}

property runtime_manifest

Gets the runtime_manifest of this RuntimeManifestEntity.

Returns:

The runtime_manifest of this RuntimeManifestEntity.

Return type:

RuntimeManifest

swagger_types = {'runtime_manifest': 'RuntimeManifest'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

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

__eq__(other)

Returns true if both objects are equal

__init__(components=None, disconnected_node_acknowledged=None, id=None, state=None)

ScheduleComponentsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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)

property 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

property id

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

Returns:

The id of this ScheduleComponentsEntity.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SchedulingDefaults(default_concurrent_tasks_by_scheduling_strategy=None, default_max_concurrent_tasks=None, default_run_duration_nanos=None, default_scheduling_period_millis=None, default_scheduling_periods_by_scheduling_strategy=None, default_scheduling_strategy=None, penalization_period_millis=None, yield_duration_millis=None)

Bases: object

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

SchedulingDefaults - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(default_concurrent_tasks_by_scheduling_strategy=None, default_max_concurrent_tasks=None, default_run_duration_nanos=None, default_scheduling_period_millis=None, default_scheduling_periods_by_scheduling_strategy=None, default_scheduling_strategy=None, penalization_period_millis=None, yield_duration_millis=None)

SchedulingDefaults - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'default_concurrent_tasks_by_scheduling_strategy': 'defaultConcurrentTasksBySchedulingStrategy', 'default_max_concurrent_tasks': 'defaultMaxConcurrentTasks', 'default_run_duration_nanos': 'defaultRunDurationNanos', 'default_scheduling_period_millis': 'defaultSchedulingPeriodMillis', 'default_scheduling_periods_by_scheduling_strategy': 'defaultSchedulingPeriodsBySchedulingStrategy', 'default_scheduling_strategy': 'defaultSchedulingStrategy', 'penalization_period_millis': 'penalizationPeriodMillis', 'yield_duration_millis': 'yieldDurationMillis'}

property default_concurrent_tasks_by_scheduling_strategy

Gets the default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults. The default concurrent tasks for each scheduling strategy

Returns:

The default_concurrent_tasks_by_scheduling_strategy of this SchedulingDefaults.

Return type:

dict(str, int)

property default_max_concurrent_tasks

Gets the default_max_concurrent_tasks of this SchedulingDefaults. The default concurrent tasks

Returns:

The default_max_concurrent_tasks of this SchedulingDefaults.

Return type:

str

property default_run_duration_nanos

Gets the default_run_duration_nanos of this SchedulingDefaults. The default run duration in nano-seconds

Returns:

The default_run_duration_nanos of this SchedulingDefaults.

Return type:

int

property default_scheduling_period_millis

Gets the default_scheduling_period_millis of this SchedulingDefaults. The default scheduling period in milliseconds

Returns:

The default_scheduling_period_millis of this SchedulingDefaults.

Return type:

int

property default_scheduling_periods_by_scheduling_strategy

Gets the default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults. The default scheduling period for each scheduling strategy

Returns:

The default_scheduling_periods_by_scheduling_strategy of this SchedulingDefaults.

Return type:

dict(str, str)

property default_scheduling_strategy

Gets the default_scheduling_strategy of this SchedulingDefaults. The name of the default scheduling strategy

Returns:

The default_scheduling_strategy of this SchedulingDefaults.

Return type:

str

property penalization_period_millis

Gets the penalization_period_millis of this SchedulingDefaults. The default penalization period in milliseconds

Returns:

The penalization_period_millis of this SchedulingDefaults.

Return type:

int

swagger_types = {'default_concurrent_tasks_by_scheduling_strategy': 'dict(str, int)', 'default_max_concurrent_tasks': 'str', 'default_run_duration_nanos': 'int', 'default_scheduling_period_millis': 'int', 'default_scheduling_periods_by_scheduling_strategy': 'dict(str, str)', 'default_scheduling_strategy': 'str', 'penalization_period_millis': 'int', 'yield_duration_millis': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property yield_duration_millis

Gets the yield_duration_millis of this SchedulingDefaults. The default yield duration in milliseconds

Returns:

The yield_duration_millis of this SchedulingDefaults.

Return type:

int

class nipyapi.nifi.models.SearchResultGroupDTO(id=None, name=None)

Bases: object

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

SearchResultGroupDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(id=None, name=None)

SearchResultGroupDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property id

Gets the id of this SearchResultGroupDTO. The id of the group.

Returns:

The id of this SearchResultGroupDTO.

Return type:

str

property name

Gets the name of this SearchResultGroupDTO. The name of the group.

Returns:

The name of this SearchResultGroupDTO.

Return type:

str

swagger_types = {'id': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SearchResultsDTO(connection_results=None, controller_service_node_results=None, funnel_results=None, input_port_results=None, label_results=None, output_port_results=None, parameter_context_results=None, parameter_provider_node_results=None, parameter_results=None, process_group_results=None, processor_results=None, remote_process_group_results=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(connection_results=None, controller_service_node_results=None, funnel_results=None, input_port_results=None, label_results=None, output_port_results=None, parameter_context_results=None, parameter_provider_node_results=None, parameter_results=None, process_group_results=None, processor_results=None, remote_process_group_results=None)

SearchResultsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'connection_results': 'connectionResults', 'controller_service_node_results': 'controllerServiceNodeResults', 'funnel_results': 'funnelResults', 'input_port_results': 'inputPortResults', 'label_results': 'labelResults', 'output_port_results': 'outputPortResults', 'parameter_context_results': 'parameterContextResults', 'parameter_provider_node_results': 'parameterProviderNodeResults', 'parameter_results': 'parameterResults', 'process_group_results': 'processGroupResults', 'processor_results': 'processorResults', 'remote_process_group_results': 'remoteProcessGroupResults'}

property 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]

property controller_service_node_results

Gets the controller_service_node_results of this SearchResultsDTO. The controller service nodes that matched the search

Returns:

The controller_service_node_results of this SearchResultsDTO.

Return type:

list[ComponentSearchResultDTO]

property 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]

property 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]

property label_results

Gets the label_results of this SearchResultsDTO. The labels that matched the search.

Returns:

The label_results of this SearchResultsDTO.

Return type:

list[ComponentSearchResultDTO]

property 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]

property 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]

property parameter_provider_node_results

Gets the parameter_provider_node_results of this SearchResultsDTO. The parameter provider nodes that matched the search

Returns:

The parameter_provider_node_results of this SearchResultsDTO.

Return type:

list[ComponentSearchResultDTO]

property 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]

property 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]

property 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]

property 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]', 'controller_service_node_results': 'list[ComponentSearchResultDTO]', 'funnel_results': 'list[ComponentSearchResultDTO]', 'input_port_results': 'list[ComponentSearchResultDTO]', 'label_results': 'list[ComponentSearchResultDTO]', 'output_port_results': 'list[ComponentSearchResultDTO]', 'parameter_context_results': 'list[ComponentSearchResultDTO]', 'parameter_provider_node_results': 'list[ComponentSearchResultDTO]', 'parameter_results': 'list[ComponentSearchResultDTO]', 'process_group_results': 'list[ComponentSearchResultDTO]', 'processor_results': 'list[ComponentSearchResultDTO]', 'remote_process_group_results': 'list[ComponentSearchResultDTO]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SearchResultsEntity(search_results_dto=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(search_results_dto=None)

SearchResultsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'search_results_dto': 'searchResultsDTO'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SnippetDTO(connections=None, funnels=None, id=None, input_ports=None, labels=None, output_ports=None, parent_group_id=None, process_groups=None, processors=None, remote_process_groups=None, uri=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(connections=None, funnels=None, id=None, input_ports=None, labels=None, output_ports=None, parent_group_id=None, process_groups=None, processors=None, remote_process_groups=None, uri=None)

SnippetDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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)

property 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)

property id

Gets the id of this SnippetDTO. The id of the snippet.

Returns:

The id of this SnippetDTO.

Return type:

str

property 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)

property 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)

property 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)

property 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

property 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)

property 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)

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this SnippetDTO. The URI of the snippet.

Returns:

The uri of this SnippetDTO.

Return type:

str

class nipyapi.nifi.models.SnippetEntity(disconnected_node_acknowledged=None, snippet=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, snippet=None)

SnippetEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'snippet': 'snippet'}

property 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

property snippet

Gets the snippet of this SnippetEntity.

Returns:

The snippet of this SnippetEntity.

Return type:

SnippetDTO

swagger_types = {'disconnected_node_acknowledged': 'bool', 'snippet': 'SnippetDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.StartVersionControlRequestEntity(disconnected_node_acknowledged=None, process_group_revision=None, versioned_flow=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, process_group_revision=None, versioned_flow=None)

StartVersionControlRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'versioned_flow': 'versionedFlow'}

property 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

property process_group_revision

Gets the process_group_revision of this StartVersionControlRequestEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow

Gets the versioned_flow of this StartVersionControlRequestEntity.

Returns:

The versioned_flow of this StartVersionControlRequestEntity.

Return type:

VersionedFlowDTO

class nipyapi.nifi.models.StateEntryDTO(cluster_node_address=None, cluster_node_id=None, key=None, value=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(cluster_node_address=None, cluster_node_id=None, key=None, value=None)

StateEntryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cluster_node_address': 'clusterNodeAddress', 'cluster_node_id': 'clusterNodeId', 'key': 'key', 'value': 'value'}

property 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

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this StateEntryDTO. The value for this state.

Returns:

The value of this StateEntryDTO.

Return type:

str

class nipyapi.nifi.models.StateMapDTO(scope=None, state=None, total_entry_count=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(scope=None, state=None, total_entry_count=None)

StateMapDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'scope': 'scope', 'state': 'state', 'total_entry_count': 'totalEntryCount'}

property scope

Gets the scope of this StateMapDTO. The scope of this StateMap.

Returns:

The scope of this StateMapDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.Stateful(description=None, scopes=None)

Bases: object

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

Stateful - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, scopes=None)

Stateful - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'scopes': 'scopes'}

property description

Gets the description of this Stateful. Description of what information is being stored in the StateManager

Returns:

The description of this Stateful.

Return type:

str

property scopes

Gets the scopes of this Stateful. Indicates the Scope(s) associated with the State that is stored and retrieved

Returns:

The scopes of this Stateful.

Return type:

list[str]

swagger_types = {'description': 'str', 'scopes': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.StatusDescriptorDTO(description=None, field=None, formatter=None, label=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(description=None, field=None, formatter=None, label=None)

StatusDescriptorDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'field': 'field', 'formatter': 'formatter', 'label': 'label'}

property description

Gets the description of this StatusDescriptorDTO. The description of the status field.

Returns:

The description of this StatusDescriptorDTO.

Return type:

str

property field

Gets the field of this StatusDescriptorDTO. The name of the status field.

Returns:

The field of this StatusDescriptorDTO.

Return type:

str

property formatter

Gets the formatter of this StatusDescriptorDTO. The formatter for the status descriptor.

Returns:

The formatter of this StatusDescriptorDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.StatusHistoryDTO(aggregate_snapshots=None, component_details=None, field_descriptors=None, generated=None, node_snapshots=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshots=None, component_details=None, field_descriptors=None, generated=None, node_snapshots=None)

StatusHistoryDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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)

property 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]

property generated

Gets the generated of this StatusHistoryDTO. When the status history was generated.

Returns:

The generated of this StatusHistoryDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.StatusHistoryEntity(can_read=None, status_history=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(can_read=None, status_history=None)

StatusHistoryEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'can_read': 'canRead', 'status_history': 'statusHistory'}

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.StatusSnapshotDTO(status_metrics=None, timestamp=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(status_metrics=None, timestamp=None)

StatusSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'status_metrics': 'statusMetrics', 'timestamp': 'timestamp'}

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

property timestamp

Gets the timestamp of this StatusSnapshotDTO. The timestamp of the snapshot.

Returns:

The timestamp of this StatusSnapshotDTO.

Return type:

datetime

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.StorageUsageDTO(free_space=None, free_space_bytes=None, identifier=None, total_space=None, total_space_bytes=None, used_space=None, used_space_bytes=None, utilization=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(free_space=None, free_space_bytes=None, identifier=None, total_space=None, total_space_bytes=None, used_space=None, used_space_bytes=None, utilization=None)

StorageUsageDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property free_space

Gets the free_space of this StorageUsageDTO. Amount of free space.

Returns:

The free_space of this StorageUsageDTO.

Return type:

str

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total_space

Gets the total_space of this StorageUsageDTO. Amount of total space.

Returns:

The total_space of this StorageUsageDTO.

Return type:

str

property 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

property used_space

Gets the used_space of this StorageUsageDTO. Amount of used space.

Returns:

The used_space of this StorageUsageDTO.

Return type:

str

property 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

property utilization

Gets the utilization of this StorageUsageDTO. Utilization of this storage location.

Returns:

The utilization of this StorageUsageDTO.

Return type:

str

class nipyapi.nifi.models.StreamingOutput

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

__eq__(other)

Returns true if both objects are equal

__init__()

StreamingOutput - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SubmitReplayRequestEntity(cluster_node_id=None, event_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(cluster_node_id=None, event_id=None)

SubmitReplayRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cluster_node_id': 'clusterNodeId', 'event_id': 'eventId'}

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SupportedMimeTypesDTO(display_name=None, mime_types=None)

Bases: object

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

SupportedMimeTypesDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(display_name=None, mime_types=None)

SupportedMimeTypesDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'display_name': 'displayName', 'mime_types': 'mimeTypes'}

property display_name

Gets the display_name of this SupportedMimeTypesDTO. The display name of the mime types.

Returns:

The display_name of this SupportedMimeTypesDTO.

Return type:

str

property mime_types

Gets the mime_types of this SupportedMimeTypesDTO. The mime types this Content Viewer supports.

Returns:

The mime_types of this SupportedMimeTypesDTO.

Return type:

list[str]

swagger_types = {'display_name': 'str', 'mime_types': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SystemDiagnosticsDTO(aggregate_snapshot=None, node_snapshots=None)

Bases: object

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

SystemDiagnosticsDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(aggregate_snapshot=None, node_snapshots=None)

SystemDiagnosticsDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property aggregate_snapshot

Gets the aggregate_snapshot of this SystemDiagnosticsDTO.

Returns:

The aggregate_snapshot of this SystemDiagnosticsDTO.

Return type:

SystemDiagnosticsSnapshotDTO

attribute_map = {'aggregate_snapshot': 'aggregateSnapshot', 'node_snapshots': 'nodeSnapshots'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SystemDiagnosticsEntity(system_diagnostics=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(system_diagnostics=None)

SystemDiagnosticsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'system_diagnostics': 'systemDiagnostics'}

swagger_types = {'system_diagnostics': 'SystemDiagnosticsDTO'}

property system_diagnostics

Gets the system_diagnostics of this SystemDiagnosticsEntity.

Returns:

The system_diagnostics of this SystemDiagnosticsEntity.

Return type:

SystemDiagnosticsDTO

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.SystemDiagnosticsSnapshotDTO(available_processors=None, content_repository_storage_usage=None, daemon_threads=None, flow_file_repository_storage_usage=None, free_heap=None, free_heap_bytes=None, free_non_heap=None, free_non_heap_bytes=None, garbage_collection=None, heap_utilization=None, max_heap=None, max_heap_bytes=None, max_non_heap=None, max_non_heap_bytes=None, non_heap_utilization=None, processor_load_average=None, provenance_repository_storage_usage=None, resource_claim_details=None, stats_last_refreshed=None, total_heap=None, total_heap_bytes=None, total_non_heap=None, total_non_heap_bytes=None, total_threads=None, uptime=None, used_heap=None, used_heap_bytes=None, used_non_heap=None, used_non_heap_bytes=None, version_info=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(available_processors=None, content_repository_storage_usage=None, daemon_threads=None, flow_file_repository_storage_usage=None, free_heap=None, free_heap_bytes=None, free_non_heap=None, free_non_heap_bytes=None, garbage_collection=None, heap_utilization=None, max_heap=None, max_heap_bytes=None, max_non_heap=None, max_non_heap_bytes=None, non_heap_utilization=None, processor_load_average=None, provenance_repository_storage_usage=None, resource_claim_details=None, stats_last_refreshed=None, total_heap=None, total_heap_bytes=None, total_non_heap=None, total_non_heap_bytes=None, total_threads=None, uptime=None, used_heap=None, used_heap_bytes=None, used_non_heap=None, used_non_heap_bytes=None, version_info=None)

SystemDiagnosticsSnapshotDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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', 'resource_claim_details': 'resourceClaimDetails', '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'}

property 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

property 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]

property daemon_threads

Gets the daemon_threads of this SystemDiagnosticsSnapshotDTO. Number of daemon threads.

Returns:

The daemon_threads of this SystemDiagnosticsSnapshotDTO.

Return type:

int

property flow_file_repository_storage_usage

Gets the flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO.

Returns:

The flow_file_repository_storage_usage of this SystemDiagnosticsSnapshotDTO.

Return type:

StorageUsageDTO

property free_heap

Gets the free_heap of this SystemDiagnosticsSnapshotDTO. Amount of free heap.

Returns:

The free_heap of this SystemDiagnosticsSnapshotDTO.

Return type:

str

property 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

property 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

property 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

property garbage_collection

Gets the garbage_collection of this SystemDiagnosticsSnapshotDTO. The garbage collection details.

Returns:

The garbage_collection of this SystemDiagnosticsSnapshotDTO.

Return type:

list[GarbageCollectionDTO]

property heap_utilization

Gets the heap_utilization of this SystemDiagnosticsSnapshotDTO. Utilization of heap.

Returns:

The heap_utilization of this SystemDiagnosticsSnapshotDTO.

Return type:

str

property max_heap

Gets the max_heap of this SystemDiagnosticsSnapshotDTO. Maximum size of heap.

Returns:

The max_heap of this SystemDiagnosticsSnapshotDTO.

Return type:

str

property 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

property 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

property 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

property 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

property 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

property 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]

property resource_claim_details

Gets the resource_claim_details of this SystemDiagnosticsSnapshotDTO.

Returns:

The resource_claim_details of this SystemDiagnosticsSnapshotDTO.

Return type:

list[ResourceClaimDetailsDTO]

property 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]', 'resource_claim_details': 'list[ResourceClaimDetailsDTO]', '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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total_heap

Gets the total_heap of this SystemDiagnosticsSnapshotDTO. Total size of heap.

Returns:

The total_heap of this SystemDiagnosticsSnapshotDTO.

Return type:

str

property 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

property 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

property 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

property total_threads

Gets the total_threads of this SystemDiagnosticsSnapshotDTO. Total number of threads.

Returns:

The total_threads of this SystemDiagnosticsSnapshotDTO.

Return type:

int

property uptime

Gets the uptime of this SystemDiagnosticsSnapshotDTO. The uptime of the Java virtual machine

Returns:

The uptime of this SystemDiagnosticsSnapshotDTO.

Return type:

str

property used_heap

Gets the used_heap of this SystemDiagnosticsSnapshotDTO. Amount of used heap.

Returns:

The used_heap of this SystemDiagnosticsSnapshotDTO.

Return type:

str

property 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

property 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

property 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

property version_info

Gets the version_info of this SystemDiagnosticsSnapshotDTO.

Returns:

The version_info of this SystemDiagnosticsSnapshotDTO.

Return type:

VersionInfoDTO

class nipyapi.nifi.models.SystemResourceConsideration(description=None, resource=None)

Bases: object

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

SystemResourceConsideration - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, resource=None)

SystemResourceConsideration - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'resource': 'resource'}

property description

Gets the description of this SystemResourceConsideration. The description of how the resource is affected

Returns:

The description of this SystemResourceConsideration.

Return type:

str

property resource

Gets the resource of this SystemResourceConsideration. The resource to consider

Returns:

The resource of this SystemResourceConsideration.

Return type:

str

swagger_types = {'description': 'str', 'resource': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.TenantDTO(configurable=None, id=None, identity=None, parent_group_id=None, position=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(configurable=None, id=None, identity=None, parent_group_id=None, position=None, versioned_component_id=None)

TenantDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property configurable

Gets the configurable of this TenantDTO. Whether this tenant is configurable.

Returns:

The configurable of this TenantDTO.

Return type:

bool

property id

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

Returns:

The id of this TenantDTO.

Return type:

str

property identity

Gets the identity of this TenantDTO. The identity of the tenant.

Returns:

The identity of this TenantDTO.

Return type:

str

property 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

property position

Gets the position of this TenantDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

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

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

TenantEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this TenantEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this TenantEntity.

Returns:

The component of this TenantEntity.

Return type:

TenantDTO

property 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

property id

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

Returns:

The id of this TenantEntity.

Return type:

str

property permissions

Gets the permissions of this TenantEntity.

Returns:

The permissions of this TenantEntity.

Return type:

PermissionsDTO

property position

Gets the position of this TenantEntity.

Returns:

The position of this TenantEntity.

Return type:

PositionDTO

property revision

Gets the revision of this TenantEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this TenantEntity.

Return type:

str

class nipyapi.nifi.models.TenantsEntity(user_groups=None, users=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(user_groups=None, users=None)

TenantsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'user_groups': 'userGroups', 'users': 'users'}

swagger_types = {'user_groups': 'list[TenantEntity]', 'users': 'list[TenantEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property user_groups

Gets the user_groups of this TenantsEntity.

Returns:

The user_groups of this TenantsEntity.

Return type:

list[TenantEntity]

property users

Gets the users of this TenantsEntity.

Returns:

The users of this TenantsEntity.

Return type:

list[TenantEntity]

class nipyapi.nifi.models.TransactionResultEntity(flow_file_sent=None, message=None, response_code=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(flow_file_sent=None, message=None, response_code=None)

TransactionResultEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'flow_file_sent': 'flowFileSent', 'message': 'message', 'response_code': 'responseCode'}

property flow_file_sent

Gets the flow_file_sent of this TransactionResultEntity.

Returns:

The flow_file_sent of this TransactionResultEntity.

Return type:

int

property message

Gets the message of this TransactionResultEntity.

Returns:

The message of this TransactionResultEntity.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.UpdateControllerServiceReferenceRequestEntity(disconnected_node_acknowledged=None, id=None, referencing_component_revisions=None, state=None, ui_only=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, id=None, referencing_component_revisions=None, state=None, ui_only=None)

UpdateControllerServiceReferenceRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'id': 'id', 'referencing_component_revisions': 'referencingComponentRevisions', 'state': 'state', 'ui_only': 'uiOnly'}

property 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

property id

Gets the id of this UpdateControllerServiceReferenceRequestEntity. The identifier of the Controller Service.

Returns:

The id of this UpdateControllerServiceReferenceRequestEntity.

Return type:

str

property 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)

property 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', 'ui_only': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property ui_only

Gets the ui_only of this UpdateControllerServiceReferenceRequestEntity. Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI.

Returns:

The ui_only of this UpdateControllerServiceReferenceRequestEntity.

Return type:

bool

class nipyapi.nifi.models.UseCase(configuration=None, description=None, input_requirement=None, keywords=None, notes=None)

Bases: object

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

UseCase - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(configuration=None, description=None, input_requirement=None, keywords=None, notes=None)

UseCase - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'configuration': 'configuration', 'description': 'description', 'input_requirement': 'inputRequirement', 'keywords': 'keywords', 'notes': 'notes'}

property configuration

Gets the configuration of this UseCase. A description of how to configure the Processor to perform the task described in the use case

Returns:

The configuration of this UseCase.

Return type:

str

property description

Gets the description of this UseCase. A description of the use case

Returns:

The description of this UseCase.

Return type:

str

property input_requirement

Gets the input_requirement of this UseCase. Specifies whether an incoming FlowFile is expected for this use case

Returns:

The input_requirement of this UseCase.

Return type:

str

property keywords

Gets the keywords of this UseCase. Keywords that pertain to the use case

Returns:

The keywords of this UseCase.

Return type:

list[str]

property notes

Gets the notes of this UseCase. Any pertinent notes about the use case

Returns:

The notes of this UseCase.

Return type:

str

swagger_types = {'configuration': 'str', 'description': 'str', 'input_requirement': 'str', 'keywords': 'list[str]', 'notes': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.UserDTO(access_policies=None, configurable=None, id=None, identity=None, parent_group_id=None, position=None, user_groups=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(access_policies=None, configurable=None, id=None, identity=None, parent_group_id=None, position=None, user_groups=None, versioned_component_id=None)

UserDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property configurable

Gets the configurable of this UserDTO. Whether this tenant is configurable.

Returns:

The configurable of this UserDTO.

Return type:

bool

property id

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

Returns:

The id of this UserDTO.

Return type:

str

property identity

Gets the identity of this UserDTO. The identity of the tenant.

Returns:

The identity of this UserDTO.

Return type:

str

property 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

property position

Gets the position of this UserDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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]

property 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

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

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

UserEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this UserEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this UserEntity.

Returns:

The component of this UserEntity.

Return type:

UserDTO

property 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

property id

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

Returns:

The id of this UserEntity.

Return type:

str

property permissions

Gets the permissions of this UserEntity.

Returns:

The permissions of this UserEntity.

Return type:

PermissionsDTO

property position

Gets the position of this UserEntity.

Returns:

The position of this UserEntity.

Return type:

PositionDTO

property revision

Gets the revision of this UserEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this UserEntity.

Return type:

str

class nipyapi.nifi.models.UserGroupDTO(access_policies=None, configurable=None, id=None, identity=None, parent_group_id=None, position=None, users=None, versioned_component_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(access_policies=None, configurable=None, id=None, identity=None, parent_group_id=None, position=None, users=None, versioned_component_id=None)

UserGroupDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property configurable

Gets the configurable of this UserGroupDTO. Whether this tenant is configurable.

Returns:

The configurable of this UserGroupDTO.

Return type:

bool

property id

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

Returns:

The id of this UserGroupDTO.

Return type:

str

property identity

Gets the identity of this UserGroupDTO. The identity of the tenant.

Returns:

The identity of this UserGroupDTO.

Return type:

str

property 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

property position

Gets the position of this UserGroupDTO.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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]

property 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

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

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

__eq__(other)

Returns true if both objects are equal

__init__(bulletins=None, component=None, disconnected_node_acknowledged=None, id=None, permissions=None, position=None, revision=None, uri=None)

UserGroupEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bulletins

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

Returns:

The bulletins of this UserGroupEntity.

Return type:

list[BulletinEntity]

property component

Gets the component of this UserGroupEntity.

Returns:

The component of this UserGroupEntity.

Return type:

UserGroupDTO

property 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

property id

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

Returns:

The id of this UserGroupEntity.

Return type:

str

property permissions

Gets the permissions of this UserGroupEntity.

Returns:

The permissions of this UserGroupEntity.

Return type:

PermissionsDTO

property position

Gets the position of this UserGroupEntity.

Returns:

The position of this UserGroupEntity.

Return type:

PositionDTO

property revision

Gets the revision of this UserGroupEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

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

Returns:

The uri of this UserGroupEntity.

Return type:

str

class nipyapi.nifi.models.UserGroupsEntity(user_groups=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(user_groups=None)

UserGroupsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'user_groups': 'userGroups'}

swagger_types = {'user_groups': 'list[UserGroupEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property user_groups

Gets the user_groups of this UserGroupsEntity.

Returns:

The user_groups of this UserGroupsEntity.

Return type:

list[UserGroupEntity]

class nipyapi.nifi.models.UsersEntity(generated=None, users=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(generated=None, users=None)

UsersEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property users

Gets the users of this UsersEntity.

Returns:

The users of this UsersEntity.

Return type:

list[UserEntity]

class nipyapi.nifi.models.VerifyConfigRequestDTO(attributes=None, complete=None, component_id=None, failure_reason=None, last_updated=None, percent_completed=None, properties=None, request_id=None, results=None, state=None, submission_time=None, update_steps=None, uri=None)

Bases: object

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

VerifyConfigRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(attributes=None, complete=None, component_id=None, failure_reason=None, last_updated=None, percent_completed=None, properties=None, request_id=None, results=None, state=None, submission_time=None, update_steps=None, uri=None)

VerifyConfigRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'attributes': 'attributes', 'complete': 'complete', 'component_id': 'componentId', 'failure_reason': 'failureReason', 'last_updated': 'lastUpdated', 'percent_completed': 'percentCompleted', 'properties': 'properties', 'request_id': 'requestId', 'results': 'results', 'state': 'state', 'submission_time': 'submissionTime', 'update_steps': 'updateSteps', 'uri': 'uri'}

property attributes

Gets the attributes of this VerifyConfigRequestDTO. FlowFile Attributes that should be used to evaluate Expression Language for resolving property values

Returns:

The attributes of this VerifyConfigRequestDTO.

Return type:

dict(str, str)

property complete

Gets the complete of this VerifyConfigRequestDTO. Whether or not the request is completed

Returns:

The complete of this VerifyConfigRequestDTO.

Return type:

bool

property component_id

Gets the component_id of this VerifyConfigRequestDTO. The ID of the component whose configuration was verified

Returns:

The component_id of this VerifyConfigRequestDTO.

Return type:

str

property failure_reason

Gets the failure_reason of this VerifyConfigRequestDTO. The reason for the request failing, or null if the request has not failed

Returns:

The failure_reason of this VerifyConfigRequestDTO.

Return type:

str

property last_updated

Gets the last_updated of this VerifyConfigRequestDTO. The timestamp of when the request was last updated

Returns:

The last_updated of this VerifyConfigRequestDTO.

Return type:

datetime

property percent_completed

Gets the percent_completed of this VerifyConfigRequestDTO. A value between 0 and 100 (inclusive) indicating how close the request is to completion

Returns:

The percent_completed of this VerifyConfigRequestDTO.

Return type:

int

property properties

Gets the properties of this VerifyConfigRequestDTO. The configured component properties

Returns:

The properties of this VerifyConfigRequestDTO.

Return type:

dict(str, str)

property request_id

Gets the request_id of this VerifyConfigRequestDTO. The ID of the request

Returns:

The request_id of this VerifyConfigRequestDTO.

Return type:

str

property results

Gets the results of this VerifyConfigRequestDTO. The Results of the verification

Returns:

The results of this VerifyConfigRequestDTO.

Return type:

list[ConfigVerificationResultDTO]

property state

Gets the state of this VerifyConfigRequestDTO. A description of the current state of the request

Returns:

The state of this VerifyConfigRequestDTO.

Return type:

str

property submission_time

Gets the submission_time of this VerifyConfigRequestDTO. The timestamp of when the request was submitted

Returns:

The submission_time of this VerifyConfigRequestDTO.

Return type:

datetime

swagger_types = {'attributes': 'dict(str, str)', 'complete': 'bool', 'component_id': 'str', 'failure_reason': 'str', 'last_updated': 'datetime', 'percent_completed': 'int', 'properties': 'dict(str, str)', 'request_id': 'str', 'results': 'list[ConfigVerificationResultDTO]', 'state': 'str', 'submission_time': 'datetime', 'update_steps': 'list[VerifyConfigUpdateStepDTO]', 'uri': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property update_steps

Gets the update_steps of this VerifyConfigRequestDTO. The steps that are required in order to complete the request, along with the status of each

Returns:

The update_steps of this VerifyConfigRequestDTO.

Return type:

list[VerifyConfigUpdateStepDTO]

property uri

Gets the uri of this VerifyConfigRequestDTO. The URI for the request

Returns:

The uri of this VerifyConfigRequestDTO.

Return type:

str

class nipyapi.nifi.models.VerifyConfigRequestEntity(request=None)

Bases: object

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

VerifyConfigRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(request=None)

VerifyConfigRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'request': 'request'}

property request

Gets the request of this VerifyConfigRequestEntity.

Returns:

The request of this VerifyConfigRequestEntity.

Return type:

VerifyConfigRequestDTO

swagger_types = {'request': 'VerifyConfigRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VerifyConfigUpdateStepDTO(complete=None, description=None, failure_reason=None)

Bases: object

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

VerifyConfigUpdateStepDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, description=None, failure_reason=None)

VerifyConfigUpdateStepDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'complete': 'complete', 'description': 'description', 'failure_reason': 'failureReason'}

property complete

Gets the complete of this VerifyConfigUpdateStepDTO. Whether or not this step has completed

Returns:

The complete of this VerifyConfigUpdateStepDTO.

Return type:

bool

property description

Gets the description of this VerifyConfigUpdateStepDTO. Explanation of what happens in this step

Returns:

The description of this VerifyConfigUpdateStepDTO.

Return type:

str

property failure_reason

Gets the failure_reason of this VerifyConfigUpdateStepDTO. An explanation of why this step failed, or null if this step did not fail

Returns:

The failure_reason of this VerifyConfigUpdateStepDTO.

Return type:

str

swagger_types = {'complete': 'bool', 'description': 'str', 'failure_reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionControlComponentMappingEntity(disconnected_node_acknowledged=None, process_group_revision=None, version_control_component_mapping=None, version_control_information=None)

Bases: object

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

VersionControlComponentMappingEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, process_group_revision=None, version_control_component_mapping=None, version_control_information=None)

VersionControlComponentMappingEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'version_control_component_mapping': 'versionControlComponentMapping', 'version_control_information': 'versionControlInformation'}

property 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

property process_group_revision

Gets the process_group_revision of this VersionControlComponentMappingEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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)

property version_control_information

Gets the version_control_information of this VersionControlComponentMappingEntity.

Returns:

The version_control_information of this VersionControlComponentMappingEntity.

Return type:

VersionControlInformationDTO

class nipyapi.nifi.models.VersionControlInformationDTO(branch=None, bucket_id=None, bucket_name=None, flow_description=None, flow_id=None, flow_name=None, group_id=None, registry_id=None, registry_name=None, state=None, state_explanation=None, storage_location=None, version=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(branch=None, bucket_id=None, bucket_name=None, flow_description=None, flow_id=None, flow_name=None, group_id=None, registry_id=None, registry_name=None, state=None, state_explanation=None, storage_location=None, version=None)

VersionControlInformationDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'branch': 'branch', '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', 'storage_location': 'storageLocation', 'version': 'version'}

property branch

Gets the branch of this VersionControlInformationDTO. The ID of the branch that the flow is stored in

Returns:

The branch of this VersionControlInformationDTO.

Return type:

str

property 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

property 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

property flow_description

Gets the flow_description of this VersionControlInformationDTO. The description of the flow

Returns:

The flow_description of this VersionControlInformationDTO.

Return type:

str

property flow_id

Gets the flow_id of this VersionControlInformationDTO. The ID of the flow

Returns:

The flow_id of this VersionControlInformationDTO.

Return type:

str

property flow_name

Gets the flow_name of this VersionControlInformationDTO. The name of the flow

Returns:

The flow_name of this VersionControlInformationDTO.

Return type:

str

property 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

property 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

property 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

property 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

property 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

property storage_location

Gets the storage_location of this VersionControlInformationDTO. The storage location

Returns:

The storage_location of this VersionControlInformationDTO.

Return type:

str

swagger_types = {'branch': 'str', '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', 'storage_location': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this VersionControlInformationDTO. The version of the flow

Returns:

The version of this VersionControlInformationDTO.

Return type:

str

class nipyapi.nifi.models.VersionControlInformationEntity(disconnected_node_acknowledged=None, process_group_revision=None, version_control_information=None)

Bases: object

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

VersionControlInformationEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, process_group_revision=None, version_control_information=None)

VersionControlInformationEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'version_control_information': 'versionControlInformation'}

property 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

property process_group_revision

Gets the process_group_revision of this VersionControlInformationEntity.

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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version_control_information

Gets the version_control_information of this VersionControlInformationEntity.

Returns:

The version_control_information of this VersionControlInformationEntity.

Return type:

VersionControlInformationDTO

class nipyapi.nifi.models.VersionInfoDTO(build_branch=None, build_revision=None, build_tag=None, build_timestamp=None, java_vendor=None, java_version=None, ni_fi_version=None, os_architecture=None, os_name=None, os_version=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(build_branch=None, build_revision=None, build_tag=None, build_timestamp=None, java_vendor=None, java_version=None, ni_fi_version=None, os_architecture=None, os_name=None, os_version=None)

VersionInfoDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property build_branch

Gets the build_branch of this VersionInfoDTO. Build branch

Returns:

The build_branch of this VersionInfoDTO.

Return type:

str

property build_revision

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

Returns:

The build_revision of this VersionInfoDTO.

Return type:

str

property build_tag

Gets the build_tag of this VersionInfoDTO. Build tag

Returns:

The build_tag of this VersionInfoDTO.

Return type:

str

property build_timestamp

Gets the build_timestamp of this VersionInfoDTO. Build timestamp

Returns:

The build_timestamp of this VersionInfoDTO.

Return type:

datetime

property java_vendor

Gets the java_vendor of this VersionInfoDTO. Java JVM vendor

Returns:

The java_vendor of this VersionInfoDTO.

Return type:

str

property java_version

Gets the java_version of this VersionInfoDTO. Java version

Returns:

The java_version of this VersionInfoDTO.

Return type:

str

property 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

property os_architecture

Gets the os_architecture of this VersionInfoDTO. Host operating system architecture

Returns:

The os_architecture of this VersionInfoDTO.

Return type:

str

property os_name

Gets the os_name of this VersionInfoDTO. Host operating system name

Returns:

The os_name of this VersionInfoDTO.

Return type:

str

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedAsset(identifier=None, name=None)

Bases: object

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

VersionedAsset - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(identifier=None, name=None)

VersionedAsset - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'identifier': 'identifier', 'name': 'name'}

property identifier

Gets the identifier of this VersionedAsset. The identifier of the asset

Returns:

The identifier of this VersionedAsset.

Return type:

str

property name

Gets the name of this VersionedAsset. The name of the asset

Returns:

The name of this VersionedAsset.

Return type:

str

swagger_types = {'identifier': 'str', 'name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedConnection(back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, comments=None, component_type=None, destination=None, flow_file_expiration=None, group_identifier=None, identifier=None, instance_identifier=None, label_index=None, load_balance_compression=None, load_balance_strategy=None, name=None, partitioning_attribute=None, position=None, prioritizers=None, selected_relationships=None, source=None, z_index=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, comments=None, component_type=None, destination=None, flow_file_expiration=None, group_identifier=None, identifier=None, instance_identifier=None, label_index=None, load_balance_compression=None, load_balance_strategy=None, name=None, partitioning_attribute=None, position=None, prioritizers=None, selected_relationships=None, source=None, z_index=None)

VersionedConnection - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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', 'instance_identifier': 'instanceIdentifier', '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'}

property 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

property 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

property bends

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

Returns:

The bends of this VersionedConnection.

Return type:

list[Position]

property comments

Gets the comments of this VersionedConnection. The user-supplied comments for the component

Returns:

The comments of this VersionedConnection.

Return type:

str

property component_type

Gets the component_type of this VersionedConnection.

Returns:

The component_type of this VersionedConnection.

Return type:

str

property destination

Gets the destination of this VersionedConnection.

Returns:

The destination of this VersionedConnection.

Return type:

ConnectableComponent

property 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

property 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

property identifier

Gets the identifier of this VersionedConnection. The component’s unique identifier

Returns:

The identifier of this VersionedConnection.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedConnection.

Return type:

str

property 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

property load_balance_compression

Gets the load_balance_compression of this VersionedConnection. Whether or not compression should be used when transferring FlowFiles between nodes Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details.

Returns:

The load_balance_compression of this VersionedConnection.

Return type:

str

property 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. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details.

Returns:

The load_balance_strategy of this VersionedConnection.

Return type:

str

property name

Gets the name of this VersionedConnection. The component’s name

Returns:

The name of this VersionedConnection.

Return type:

str

property 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

property position

Gets the position of this VersionedConnection.

Returns:

The position of this VersionedConnection.

Return type:

Position

property prioritizers

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

Returns:

The prioritizers of this VersionedConnection.

Return type:

list[str]

property 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]

property source

Gets the source of this VersionedConnection.

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', 'instance_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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.VersionedControllerService(annotation_data=None, bulletin_level=None, bundle=None, comments=None, component_type=None, controller_service_apis=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, type=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, bulletin_level=None, bundle=None, comments=None, component_type=None, controller_service_apis=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, type=None)

VersionedControllerService - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'controller_service_apis': 'controllerServiceApis', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'scheduled_state': 'scheduledState', 'type': 'type'}

property bulletin_level

Gets the bulletin_level of this VersionedControllerService. The level at which the controller service will report bulletins.

Returns:

The bulletin_level of this VersionedControllerService.

Return type:

str

property bundle

Gets the bundle of this VersionedControllerService.

Returns:

The bundle of this VersionedControllerService.

Return type:

Bundle

property comments

Gets the comments of this VersionedControllerService. The user-supplied comments for the component

Returns:

The comments of this VersionedControllerService.

Return type:

str

property component_type

Gets the component_type of this VersionedControllerService.

Returns:

The component_type of this VersionedControllerService.

Return type:

str

property 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]

property 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

property identifier

Gets the identifier of this VersionedControllerService. The component’s unique identifier

Returns:

The identifier of this VersionedControllerService.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedControllerService.

Return type:

str

property name

Gets the name of this VersionedControllerService. The component’s name

Returns:

The name of this VersionedControllerService.

Return type:

str

property position

Gets the position of this VersionedControllerService.

Returns:

The position of this VersionedControllerService.

Return type:

Position

property properties

Gets the properties of this VersionedControllerService. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:

The properties of this VersionedControllerService.

Return type:

dict(str, str)

property property_descriptors

Gets the property_descriptors of this VersionedControllerService. The property descriptors for the component.

Returns:

The property_descriptors of this VersionedControllerService.

Return type:

dict(str, VersionedPropertyDescriptor)

property scheduled_state

Gets the scheduled_state of this VersionedControllerService. The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED

Returns:

The scheduled_state of this VersionedControllerService.

Return type:

str

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'controller_service_apis': 'list[ControllerServiceAPI]', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this VersionedControllerService. The type of the extension component

Returns:

The type of this VersionedControllerService.

Return type:

str

class nipyapi.nifi.models.VersionedFlowCoordinates(branch=None, bucket_id=None, flow_id=None, latest=None, registry_id=None, storage_location=None, version=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(branch=None, bucket_id=None, flow_id=None, latest=None, registry_id=None, storage_location=None, version=None)

VersionedFlowCoordinates - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'branch': 'branch', 'bucket_id': 'bucketId', 'flow_id': 'flowId', 'latest': 'latest', 'registry_id': 'registryId', 'storage_location': 'storageLocation', 'version': 'version'}

property branch

Gets the branch of this VersionedFlowCoordinates. The name of the branch that the flow resides in

Returns:

The branch of this VersionedFlowCoordinates.

Return type:

str

property 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

property flow_id

Gets the flow_id of this VersionedFlowCoordinates. The UUID of the flow

Returns:

The flow_id of this VersionedFlowCoordinates.

Return type:

str

property 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

property registry_id

Gets the registry_id of this VersionedFlowCoordinates. The identifier of the Flow Registry that contains the flow

Returns:

The registry_id of this VersionedFlowCoordinates.

Return type:

str

property storage_location

Gets the storage_location of this VersionedFlowCoordinates. The location of the Flow Registry that stores the flow

Returns:

The storage_location of this VersionedFlowCoordinates.

Return type:

str

swagger_types = {'branch': 'str', 'bucket_id': 'str', 'flow_id': 'str', 'latest': 'bool', 'registry_id': 'str', 'storage_location': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this VersionedFlowCoordinates. The version of the flow

Returns:

The version of this VersionedFlowCoordinates.

Return type:

str

class nipyapi.nifi.models.VersionedFlowDTO(action=None, branch=None, bucket_id=None, comments=None, description=None, flow_id=None, flow_name=None, registry_id=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(action=None, branch=None, bucket_id=None, comments=None, description=None, flow_id=None, flow_name=None, registry_id=None)

VersionedFlowDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property action

Gets the action of this VersionedFlowDTO. The action being performed

Returns:

The action of this VersionedFlowDTO.

Return type:

str

attribute_map = {'action': 'action', 'branch': 'branch', 'bucket_id': 'bucketId', 'comments': 'comments', 'description': 'description', 'flow_id': 'flowId', 'flow_name': 'flowName', 'registry_id': 'registryId'}

property branch

Gets the branch of this VersionedFlowDTO. The branch where the flow is stored

Returns:

The branch of this VersionedFlowDTO.

Return type:

str

property 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

property comments

Gets the comments of this VersionedFlowDTO. Comments for the changeset

Returns:

The comments of this VersionedFlowDTO.

Return type:

str

property description

Gets the description of this VersionedFlowDTO. A description of the flow

Returns:

The description of this VersionedFlowDTO.

Return type:

str

property flow_id

Gets the flow_id of this VersionedFlowDTO. The ID of the flow

Returns:

The flow_id of this VersionedFlowDTO.

Return type:

str

property flow_name

Gets the flow_name of this VersionedFlowDTO. The name of the flow

Returns:

The flow_name of this VersionedFlowDTO.

Return type:

str

property 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', 'branch': 'str', 'bucket_id': 'str', 'comments': 'str', 'description': 'str', 'flow_id': 'str', 'flow_name': 'str', 'registry_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedFlowEntity(versioned_flow=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(versioned_flow=None)

VersionedFlowEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'versioned_flow': 'versionedFlow'}

swagger_types = {'versioned_flow': 'VersionedFlowDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow

Gets the versioned_flow of this VersionedFlowEntity.

Returns:

The versioned_flow of this VersionedFlowEntity.

Return type:

VersionedFlowDTO

class nipyapi.nifi.models.VersionedFlowSnapshotEntity(disconnected_node_acknowledged=None, process_group_revision=None, registry_id=None, update_descendant_versioned_flows=None, versioned_flow=None, versioned_flow_snapshot=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, process_group_revision=None, registry_id=None, update_descendant_versioned_flows=None, versioned_flow=None, versioned_flow_snapshot=None)

VersionedFlowSnapshotEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'process_group_revision': 'processGroupRevision', 'registry_id': 'registryId', 'update_descendant_versioned_flows': 'updateDescendantVersionedFlows', 'versioned_flow': 'versionedFlow', 'versioned_flow_snapshot': 'versionedFlowSnapshot'}

property 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

property process_group_revision

Gets the process_group_revision of this VersionedFlowSnapshotEntity.

Returns:

The process_group_revision of this VersionedFlowSnapshotEntity.

Return type:

RevisionDTO

property 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': 'RegisteredFlowSnapshot', 'versioned_flow_snapshot': 'RegisteredFlowSnapshot'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property versioned_flow

Gets the versioned_flow of this VersionedFlowSnapshotEntity.

Returns:

The versioned_flow of this VersionedFlowSnapshotEntity.

Return type:

RegisteredFlowSnapshot

property versioned_flow_snapshot

Gets the versioned_flow_snapshot of this VersionedFlowSnapshotEntity.

Returns:

The versioned_flow_snapshot of this VersionedFlowSnapshotEntity.

Return type:

RegisteredFlowSnapshot

class nipyapi.nifi.models.VersionedFlowSnapshotMetadataEntity(registry_id=None, versioned_flow_snapshot_metadata=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(registry_id=None, versioned_flow_snapshot_metadata=None)

VersionedFlowSnapshotMetadataEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'registry_id': 'registryId', 'versioned_flow_snapshot_metadata': 'versionedFlowSnapshotMetadata'}

property 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': 'RegisteredFlowSnapshotMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow_snapshot_metadata

Gets the versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity.

Returns:

The versioned_flow_snapshot_metadata of this VersionedFlowSnapshotMetadataEntity.

Return type:

RegisteredFlowSnapshotMetadata

class nipyapi.nifi.models.VersionedFlowSnapshotMetadataSetEntity(versioned_flow_snapshot_metadata_set=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(versioned_flow_snapshot_metadata_set=None)

VersionedFlowSnapshotMetadataSetEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'versioned_flow_snapshot_metadata_set': 'versionedFlowSnapshotMetadataSet'}

swagger_types = {'versioned_flow_snapshot_metadata_set': 'list[VersionedFlowSnapshotMetadataEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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]

class nipyapi.nifi.models.VersionedFlowUpdateRequestDTO(complete=None, failure_reason=None, last_updated=None, percent_completed=None, process_group_id=None, request_id=None, state=None, uri=None, version_control_information=None)

Bases: object

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

VersionedFlowUpdateRequestDTO - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(complete=None, failure_reason=None, last_updated=None, percent_completed=None, process_group_id=None, request_id=None, state=None, uri=None, version_control_information=None)

VersionedFlowUpdateRequestDTO - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property complete

Gets the complete of this VersionedFlowUpdateRequestDTO. Whether or not this request has completed

Returns:

The complete of this VersionedFlowUpdateRequestDTO.

Return type:

bool

property 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

property 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

property 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

property process_group_id

Gets the process_group_id of this VersionedFlowUpdateRequestDTO. The unique ID of the Process Group being updated

Returns:

The process_group_id of this VersionedFlowUpdateRequestDTO.

Return type:

str

property 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

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property version_control_information

Gets the version_control_information of this VersionedFlowUpdateRequestDTO.

Returns:

The version_control_information of this VersionedFlowUpdateRequestDTO.

Return type:

VersionControlInformationDTO

class nipyapi.nifi.models.VersionedFlowUpdateRequestEntity(process_group_revision=None, request=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(process_group_revision=None, request=None)

VersionedFlowUpdateRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'process_group_revision': 'processGroupRevision', 'request': 'request'}

property process_group_revision

Gets the process_group_revision of this VersionedFlowUpdateRequestEntity.

Returns:

The process_group_revision of this VersionedFlowUpdateRequestEntity.

Return type:

RevisionDTO

property request

Gets the request of this VersionedFlowUpdateRequestEntity.

Returns:

The request of this VersionedFlowUpdateRequestEntity.

Return type:

VersionedFlowUpdateRequestDTO

swagger_types = {'process_group_revision': 'RevisionDTO', 'request': 'VersionedFlowUpdateRequestDTO'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedFlowsEntity(versioned_flows=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(versioned_flows=None)

VersionedFlowsEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'versioned_flows': 'versionedFlows'}

swagger_types = {'versioned_flows': 'list[VersionedFlowEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flows

Gets the versioned_flows of this VersionedFlowsEntity.

Returns:

The versioned_flows of this VersionedFlowsEntity.

Return type:

list[VersionedFlowEntity]

class nipyapi.nifi.models.VersionedFunnel(comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None)

VersionedFunnel - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position'}

property comments

Gets the comments of this VersionedFunnel. The user-supplied comments for the component

Returns:

The comments of this VersionedFunnel.

Return type:

str

property component_type

Gets the component_type of this VersionedFunnel.

Returns:

The component_type of this VersionedFunnel.

Return type:

str

property 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

property identifier

Gets the identifier of this VersionedFunnel. The component’s unique identifier

Returns:

The identifier of this VersionedFunnel.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedFunnel.

Return type:

str

property name

Gets the name of this VersionedFunnel. The component’s name

Returns:

The name of this VersionedFunnel.

Return type:

str

property position

Gets the position of this VersionedFunnel.

Returns:

The position of this VersionedFunnel.

Return type:

Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedLabel(comments=None, component_type=None, group_identifier=None, height=None, identifier=None, instance_identifier=None, label=None, name=None, position=None, style=None, width=None, z_index=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, group_identifier=None, height=None, identifier=None, instance_identifier=None, label=None, name=None, position=None, style=None, width=None, z_index=None)

VersionedLabel - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'height': 'height', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label': 'label', 'name': 'name', 'position': 'position', 'style': 'style', 'width': 'width', 'z_index': 'zIndex'}

property comments

Gets the comments of this VersionedLabel. The user-supplied comments for the component

Returns:

The comments of this VersionedLabel.

Return type:

str

property component_type

Gets the component_type of this VersionedLabel.

Returns:

The component_type of this VersionedLabel.

Return type:

str

property 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

property 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

property identifier

Gets the identifier of this VersionedLabel. The component’s unique identifier

Returns:

The identifier of this VersionedLabel.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedLabel.

Return type:

str

property label

Gets the label of this VersionedLabel. The text that appears in the label.

Returns:

The label of this VersionedLabel.

Return type:

str

property name

Gets the name of this VersionedLabel. The component’s name

Returns:

The name of this VersionedLabel.

Return type:

str

property position

Gets the position of this VersionedLabel.

Returns:

The position of this VersionedLabel.

Return type:

Position

property 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', 'instance_identifier': 'str', 'label': 'str', 'name': 'str', 'position': 'Position', 'style': 'dict(str, str)', 'width': 'float', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

property z_index

Gets the z_index of this VersionedLabel. The z index of the connection.

Returns:

The z_index of this VersionedLabel.

Return type:

int

class nipyapi.nifi.models.VersionedParameter(description=None, name=None, provided=None, referenced_assets=None, sensitive=None, value=None)

Bases: object

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

VersionedParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None, provided=None, referenced_assets=None, sensitive=None, value=None)

VersionedParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'name': 'name', 'provided': 'provided', 'referenced_assets': 'referencedAssets', 'sensitive': 'sensitive', 'value': 'value'}

property description

Gets the description of this VersionedParameter. The description of the param

Returns:

The description of this VersionedParameter.

Return type:

str

property name

Gets the name of this VersionedParameter. The name of the parameter

Returns:

The name of this VersionedParameter.

Return type:

str

property provided

Gets the provided of this VersionedParameter. Whether or not the parameter value is provided by a ParameterProvider

Returns:

The provided of this VersionedParameter.

Return type:

bool

property referenced_assets

Gets the referenced_assets of this VersionedParameter. The assets that are referenced by this parameter

Returns:

The referenced_assets of this VersionedParameter.

Return type:

list[VersionedAsset]

property sensitive

Gets the sensitive of this VersionedParameter. Whether or not the parameter value is sensitive

Returns:

The sensitive of this VersionedParameter.

Return type:

bool

swagger_types = {'description': 'str', 'name': 'str', 'provided': 'bool', 'referenced_assets': 'list[VersionedAsset]', 'sensitive': 'bool', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this VersionedParameter. The value of the parameter

Returns:

The value of this VersionedParameter.

Return type:

str

class nipyapi.nifi.models.VersionedParameterContext(comments=None, component_type=None, description=None, group_identifier=None, identifier=None, inherited_parameter_contexts=None, instance_identifier=None, name=None, parameter_group_name=None, parameter_provider=None, parameters=None, position=None, synchronized=None)

Bases: object

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

VersionedParameterContext - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, description=None, group_identifier=None, identifier=None, inherited_parameter_contexts=None, instance_identifier=None, name=None, parameter_group_name=None, parameter_provider=None, parameters=None, position=None, synchronized=None)

VersionedParameterContext - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'description': 'description', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'inherited_parameter_contexts': 'inheritedParameterContexts', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'parameter_group_name': 'parameterGroupName', 'parameter_provider': 'parameterProvider', 'parameters': 'parameters', 'position': 'position', 'synchronized': 'synchronized'}

property comments

Gets the comments of this VersionedParameterContext. The user-supplied comments for the component

Returns:

The comments of this VersionedParameterContext.

Return type:

str

property component_type

Gets the component_type of this VersionedParameterContext.

Returns:

The component_type of this VersionedParameterContext.

Return type:

str

property description

Gets the description of this VersionedParameterContext. The description of the parameter context

Returns:

The description of this VersionedParameterContext.

Return type:

str

property group_identifier

Gets the group_identifier of this VersionedParameterContext. The ID of the Process Group that this component belongs to

Returns:

The group_identifier of this VersionedParameterContext.

Return type:

str

property identifier

Gets the identifier of this VersionedParameterContext. The component’s unique identifier

Returns:

The identifier of this VersionedParameterContext.

Return type:

str

property inherited_parameter_contexts

Gets the inherited_parameter_contexts of this VersionedParameterContext. The names of additional parameter contexts from which to inherit parameters

Returns:

The inherited_parameter_contexts of this VersionedParameterContext.

Return type:

list[str]

property instance_identifier

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

Returns:

The instance_identifier of this VersionedParameterContext.

Return type:

str

property name

Gets the name of this VersionedParameterContext. The component’s name

Returns:

The name of this VersionedParameterContext.

Return type:

str

property parameter_group_name

Gets the parameter_group_name of this VersionedParameterContext. The corresponding parameter group name fetched from the parameter provider, if applicable

Returns:

The parameter_group_name of this VersionedParameterContext.

Return type:

str

property parameter_provider

Gets the parameter_provider of this VersionedParameterContext. The identifier of an optional parameter provider

Returns:

The parameter_provider of this VersionedParameterContext.

Return type:

str

property parameters

Gets the parameters of this VersionedParameterContext. The parameters in the context

Returns:

The parameters of this VersionedParameterContext.

Return type:

list[VersionedParameter]

property position

Gets the position of this VersionedParameterContext.

Returns:

The position of this VersionedParameterContext.

Return type:

Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'description': 'str', 'group_identifier': 'str', 'identifier': 'str', 'inherited_parameter_contexts': 'list[str]', 'instance_identifier': 'str', 'name': 'str', 'parameter_group_name': 'str', 'parameter_provider': 'str', 'parameters': 'list[VersionedParameter]', 'position': 'Position', 'synchronized': 'bool'}

property synchronized

Gets the synchronized of this VersionedParameterContext. True if the parameter provider is set and the context should receive updates when its parameters are next fetched

Returns:

The synchronized of this VersionedParameterContext.

Return type:

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedPort(allow_remote_access=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, port_function=None, position=None, scheduled_state=None, type=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(allow_remote_access=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, port_function=None, position=None, scheduled_state=None, type=None)

VersionedPort - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'port_function': 'portFunction', 'position': 'position', 'scheduled_state': 'scheduledState', 'type': 'type'}

property comments

Gets the comments of this VersionedPort. The user-supplied comments for the component

Returns:

The comments of this VersionedPort.

Return type:

str

property component_type

Gets the component_type of this VersionedPort.

Returns:

The component_type of this VersionedPort.

Return type:

str

property 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

property 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

property identifier

Gets the identifier of this VersionedPort. The component’s unique identifier

Returns:

The identifier of this VersionedPort.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedPort.

Return type:

str

property name

Gets the name of this VersionedPort. The component’s name

Returns:

The name of this VersionedPort.

Return type:

str

property port_function

Gets the port_function of this VersionedPort. Specifies how the Port should function

Returns:

The port_function of this VersionedPort.

Return type:

str

property position

Gets the position of this VersionedPort.

Returns:

The position of this VersionedPort.

Return type:

Position

property 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', 'instance_identifier': 'str', 'name': 'str', 'port_function': 'str', 'position': 'Position', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this VersionedPort.

Return type:

str

class nipyapi.nifi.models.VersionedProcessGroup(comments=None, component_type=None, connections=None, controller_services=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, execution_engine=None, flow_file_concurrency=None, flow_file_outbound_policy=None, funnels=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, labels=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_ports=None, parameter_context_name=None, position=None, process_groups=None, processors=None, remote_process_groups=None, scheduled_state=None, stateless_flow_timeout=None, versioned_flow_coordinates=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, connections=None, controller_services=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, execution_engine=None, flow_file_concurrency=None, flow_file_outbound_policy=None, funnels=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, labels=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_ports=None, parameter_context_name=None, position=None, process_groups=None, processors=None, remote_process_groups=None, scheduled_state=None, stateless_flow_timeout=None, versioned_flow_coordinates=None)

VersionedProcessGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'connections': 'connections', 'controller_services': 'controllerServices', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'default_flow_file_expiration': 'defaultFlowFileExpiration', 'execution_engine': 'executionEngine', 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', 'funnels': 'funnels', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'labels': 'labels', 'log_file_suffix': 'logFileSuffix', 'max_concurrent_tasks': 'maxConcurrentTasks', 'name': 'name', 'output_ports': 'outputPorts', 'parameter_context_name': 'parameterContextName', 'position': 'position', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'scheduled_state': 'scheduledState', 'stateless_flow_timeout': 'statelessFlowTimeout', 'versioned_flow_coordinates': 'versionedFlowCoordinates'}

property comments

Gets the comments of this VersionedProcessGroup. The user-supplied comments for the component

Returns:

The comments of this VersionedProcessGroup.

Return type:

str

property component_type

Gets the component_type of this VersionedProcessGroup.

Returns:

The component_type of this VersionedProcessGroup.

Return type:

str

property connections

Gets the connections of this VersionedProcessGroup. The Connections

Returns:

The connections of this VersionedProcessGroup.

Return type:

list[VersionedConnection]

property controller_services

Gets the controller_services of this VersionedProcessGroup. The Controller Services

Returns:

The controller_services of this VersionedProcessGroup.

Return type:

list[VersionedControllerService]

property default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:

The default_back_pressure_data_size_threshold of this VersionedProcessGroup.

Return type:

str

property default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:

The default_back_pressure_object_threshold of this VersionedProcessGroup.

Return type:

int

property default_flow_file_expiration

Gets the default_flow_file_expiration of this VersionedProcessGroup. The default FlowFile Expiration for this Process Group.

Returns:

The default_flow_file_expiration of this VersionedProcessGroup.

Return type:

str

property execution_engine

Gets the execution_engine of this VersionedProcessGroup. The Execution Engine that should be used to run the components within the group.

Returns:

The execution_engine of this VersionedProcessGroup.

Return type:

str

property flow_file_concurrency

Gets the flow_file_concurrency of this VersionedProcessGroup. The configured FlowFile Concurrency for the Process Group

Returns:

The flow_file_concurrency of this VersionedProcessGroup.

Return type:

str

property flow_file_outbound_policy

Gets the flow_file_outbound_policy of this VersionedProcessGroup. The FlowFile Outbound Policy for the Process Group

Returns:

The flow_file_outbound_policy of this VersionedProcessGroup.

Return type:

str

property funnels

Gets the funnels of this VersionedProcessGroup. The Funnels

Returns:

The funnels of this VersionedProcessGroup.

Return type:

list[VersionedFunnel]

property 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

property identifier

Gets the identifier of this VersionedProcessGroup. The component’s unique identifier

Returns:

The identifier of this VersionedProcessGroup.

Return type:

str

property input_ports

Gets the input_ports of this VersionedProcessGroup. The Input Ports

Returns:

The input_ports of this VersionedProcessGroup.

Return type:

list[VersionedPort]

property instance_identifier

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

Returns:

The instance_identifier of this VersionedProcessGroup.

Return type:

str

property labels

Gets the labels of this VersionedProcessGroup. The Labels

Returns:

The labels of this VersionedProcessGroup.

Return type:

list[VersionedLabel]

property log_file_suffix

Gets the log_file_suffix of this VersionedProcessGroup. The log file suffix for this Process Group for dedicated logging.

Returns:

The log_file_suffix of this VersionedProcessGroup.

Return type:

str

property max_concurrent_tasks

Gets the max_concurrent_tasks of this VersionedProcessGroup. The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine

Returns:

The max_concurrent_tasks of this VersionedProcessGroup.

Return type:

int

property name

Gets the name of this VersionedProcessGroup. The component’s name

Returns:

The name of this VersionedProcessGroup.

Return type:

str

property output_ports

Gets the output_ports of this VersionedProcessGroup. The Output Ports

Returns:

The output_ports of this VersionedProcessGroup.

Return type:

list[VersionedPort]

property 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

property position

Gets the position of this VersionedProcessGroup.

Returns:

The position of this VersionedProcessGroup.

Return type:

Position

property process_groups

Gets the process_groups of this VersionedProcessGroup. The child Process Groups

Returns:

The process_groups of this VersionedProcessGroup.

Return type:

list[VersionedProcessGroup]

property processors

Gets the processors of this VersionedProcessGroup. The Processors

Returns:

The processors of this VersionedProcessGroup.

Return type:

list[VersionedProcessor]

property 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]

property scheduled_state

Gets the scheduled_state of this VersionedProcessGroup. The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance.

Returns:

The scheduled_state of this VersionedProcessGroup.

Return type:

str

property stateless_flow_timeout

Gets the stateless_flow_timeout of this VersionedProcessGroup. The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure

Returns:

The stateless_flow_timeout of this VersionedProcessGroup.

Return type:

str

swagger_types = {'comments': 'str', 'component_type': 'str', 'connections': 'list[VersionedConnection]', 'controller_services': 'list[VersionedControllerService]', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': 'str', 'execution_engine': 'str', 'flow_file_concurrency': 'str', 'flow_file_outbound_policy': 'str', 'funnels': 'list[VersionedFunnel]', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedPort]', 'instance_identifier': 'str', 'labels': 'list[VersionedLabel]', 'log_file_suffix': 'str', 'max_concurrent_tasks': 'int', 'name': 'str', 'output_ports': 'list[VersionedPort]', 'parameter_context_name': 'str', 'position': 'Position', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', 'scheduled_state': 'str', 'stateless_flow_timeout': 'str', 'versioned_flow_coordinates': 'VersionedFlowCoordinates'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow_coordinates

Gets the versioned_flow_coordinates of this VersionedProcessGroup.

Returns:

The versioned_flow_coordinates of this VersionedProcessGroup.

Return type:

VersionedFlowCoordinates

class nipyapi.nifi.models.VersionedProcessor(annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, bundle=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, execution_node=None, group_identifier=None, identifier=None, instance_identifier=None, max_backoff_period=None, name=None, penalty_duration=None, position=None, properties=None, property_descriptors=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, style=None, type=None, yield_duration=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, bundle=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, execution_node=None, group_identifier=None, identifier=None, instance_identifier=None, max_backoff_period=None, name=None, penalty_duration=None, position=None, properties=None, property_descriptors=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, style=None, type=None, yield_duration=None)

VersionedProcessor - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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', 'backoff_mechanism': 'backoffMechanism', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'execution_node': 'executionNode', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'max_backoff_period': 'maxBackoffPeriod', 'name': 'name', 'penalty_duration': 'penaltyDuration', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'retried_relationships': 'retriedRelationships', 'retry_count': 'retryCount', 'run_duration_millis': 'runDurationMillis', 'scheduled_state': 'scheduledState', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'style': 'style', 'type': 'type', 'yield_duration': 'yieldDuration'}

property 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]

property backoff_mechanism

Gets the backoff_mechanism of this VersionedProcessor. Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR.

Returns:

The backoff_mechanism of this VersionedProcessor.

Return type:

str

property 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

property bundle

Gets the bundle of this VersionedProcessor.

Returns:

The bundle of this VersionedProcessor.

Return type:

Bundle

property comments

Gets the comments of this VersionedProcessor. The user-supplied comments for the component

Returns:

The comments of this VersionedProcessor.

Return type:

str

property component_type

Gets the component_type of this VersionedProcessor.

Returns:

The component_type of this VersionedProcessor.

Return type:

str

property 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

property 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

property 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

property identifier

Gets the identifier of this VersionedProcessor. The component’s unique identifier

Returns:

The identifier of this VersionedProcessor.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedProcessor.

Return type:

str

property max_backoff_period

Gets the max_backoff_period of this VersionedProcessor. Maximum amount of time to be waited during a retry period.

Returns:

The max_backoff_period of this VersionedProcessor.

Return type:

str

property name

Gets the name of this VersionedProcessor. The component’s name

Returns:

The name of this VersionedProcessor.

Return type:

str

property 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

property position

Gets the position of this VersionedProcessor.

Returns:

The position of this VersionedProcessor.

Return type:

Position

property properties

Gets the properties of this VersionedProcessor. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:

The properties of this VersionedProcessor.

Return type:

dict(str, str)

property property_descriptors

Gets the property_descriptors of this VersionedProcessor. The property descriptors for the component.

Returns:

The property_descriptors of this VersionedProcessor.

Return type:

dict(str, VersionedPropertyDescriptor)

property retried_relationships

Gets the retried_relationships of this VersionedProcessor. All the relationships should be retried.

Returns:

The retried_relationships of this VersionedProcessor.

Return type:

list[str]

property retry_count

Gets the retry_count of this VersionedProcessor. Overall number of retries.

Returns:

The retry_count of this VersionedProcessor.

Return type:

int

property 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

property 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

property 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

property scheduling_strategy

Gets the scheduling_strategy of this VersionedProcessor. Indicates how the processor should be scheduled to run.

Returns:

The scheduling_strategy of this VersionedProcessor.

Return type:

str

property 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]', 'backoff_mechanism': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'execution_node': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'max_backoff_period': 'str', 'name': 'str', 'penalty_duration': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'retried_relationships': 'list[str]', 'retry_count': 'int', 'run_duration_millis': 'int', 'scheduled_state': 'str', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'style': 'dict(str, str)', 'type': 'str', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this VersionedProcessor. The type of the extension component

Returns:

The type of this VersionedProcessor.

Return type:

str

property 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

class nipyapi.nifi.models.VersionedPropertyDescriptor(display_name=None, dynamic=None, identifies_controller_service=None, name=None, resource_definition=None, sensitive=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(display_name=None, dynamic=None, identifies_controller_service=None, name=None, resource_definition=None, sensitive=None)

VersionedPropertyDescriptor - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'display_name': 'displayName', 'dynamic': 'dynamic', 'identifies_controller_service': 'identifiesControllerService', 'name': 'name', 'resource_definition': 'resourceDefinition', 'sensitive': 'sensitive'}

property 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

property dynamic

Gets the dynamic of this VersionedPropertyDescriptor. Whether or not the property is user-defined

Returns:

The dynamic of this VersionedPropertyDescriptor.

Return type:

bool

property 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

property name

Gets the name of this VersionedPropertyDescriptor. The name of the property

Returns:

The name of this VersionedPropertyDescriptor.

Return type:

str

property resource_definition

Gets the resource_definition of this VersionedPropertyDescriptor.

Returns:

The resource_definition of this VersionedPropertyDescriptor.

Return type:

VersionedResourceDefinition

property 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', 'dynamic': 'bool', 'identifies_controller_service': 'bool', 'name': 'str', 'resource_definition': 'VersionedResourceDefinition', 'sensitive': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedRemoteGroupPort(batch_size=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, remote_group_id=None, scheduled_state=None, target_id=None, use_compression=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(batch_size=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, remote_group_id=None, scheduled_state=None, target_id=None, use_compression=None)

VersionedRemoteGroupPort - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'batch_size': 'batchSize', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'remote_group_id': 'remoteGroupId', 'scheduled_state': 'scheduledState', 'target_id': 'targetId', 'use_compression': 'useCompression'}

property batch_size

Gets the batch_size of this VersionedRemoteGroupPort.

Returns:

The batch_size of this VersionedRemoteGroupPort.

Return type:

BatchSize

property comments

Gets the comments of this VersionedRemoteGroupPort. The user-supplied comments for the component

Returns:

The comments of this VersionedRemoteGroupPort.

Return type:

str

property component_type

Gets the component_type of this VersionedRemoteGroupPort.

Returns:

The component_type of this VersionedRemoteGroupPort.

Return type:

str

property 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

property 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

property identifier

Gets the identifier of this VersionedRemoteGroupPort. The component’s unique identifier

Returns:

The identifier of this VersionedRemoteGroupPort.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedRemoteGroupPort.

Return type:

str

property name

Gets the name of this VersionedRemoteGroupPort. The component’s name

Returns:

The name of this VersionedRemoteGroupPort.

Return type:

str

property position

Gets the position of this VersionedRemoteGroupPort.

Returns:

The position of this VersionedRemoteGroupPort.

Return type:

Position

property 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

property 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', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'remote_group_id': 'str', 'scheduled_state': 'str', 'target_id': 'str', 'use_compression': 'bool'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property 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

class nipyapi.nifi.models.VersionedRemoteProcessGroup(comments=None, communications_timeout=None, component_type=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, local_network_interface=None, name=None, output_ports=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_uris=None, transport_protocol=None, yield_duration=None)

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

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, communications_timeout=None, component_type=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, local_network_interface=None, name=None, output_ports=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_uris=None, transport_protocol=None, yield_duration=None)

VersionedRemoteProcessGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_ports': 'outputPorts', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_password': 'proxyPassword', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_uris': 'targetUris', 'transport_protocol': 'transportProtocol', 'yield_duration': 'yieldDuration'}

property comments

Gets the comments of this VersionedRemoteProcessGroup. The user-supplied comments for the component

Returns:

The comments of this VersionedRemoteProcessGroup.

Return type:

str

property 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

property component_type

Gets the component_type of this VersionedRemoteProcessGroup.

Returns:

The component_type of this VersionedRemoteProcessGroup.

Return type:

str

property 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

property identifier

Gets the identifier of this VersionedRemoteProcessGroup. The component’s unique identifier

Returns:

The identifier of this VersionedRemoteProcessGroup.

Return type:

str

property 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]

property instance_identifier

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

Returns:

The instance_identifier of this VersionedRemoteProcessGroup.

Return type:

str

property 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

property name

Gets the name of this VersionedRemoteProcessGroup. The component’s name

Returns:

The name of this VersionedRemoteProcessGroup.

Return type:

str

property 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]

property position

Gets the position of this VersionedRemoteProcessGroup.

Returns:

The position of this VersionedRemoteProcessGroup.

Return type:

Position

property proxy_host

Gets the proxy_host of this VersionedRemoteProcessGroup.

Returns:

The proxy_host of this VersionedRemoteProcessGroup.

Return type:

str

property proxy_password

Gets the proxy_password of this VersionedRemoteProcessGroup.

Returns:

The proxy_password of this VersionedRemoteProcessGroup.

Return type:

str

property proxy_port

Gets the proxy_port of this VersionedRemoteProcessGroup.

Returns:

The proxy_port of this VersionedRemoteProcessGroup.

Return type:

int

property 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]', 'instance_identifier': 'str', 'local_network_interface': 'str', 'name': 'str', 'output_ports': 'list[VersionedRemoteGroupPort]', 'position': 'Position', 'proxy_host': 'str', 'proxy_password': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_uris': 'str', 'transport_protocol': 'str', 'yield_duration': 'str'}

property 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()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property transport_protocol

Gets the transport_protocol of this VersionedRemoteProcessGroup. The Transport Protocol that is used for Site-to-Site communications. Possible returned values: RAW, HTTP.

Returns:

The transport_protocol of this VersionedRemoteProcessGroup.

Return type:

str

property 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

class nipyapi.nifi.models.VersionedReportingTask(annotation_data=None, bundle=None, comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, type=None)

Bases: object

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

VersionedReportingTask - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, bundle=None, comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, type=None)

VersionedReportingTask - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property annotation_data

Gets the annotation_data of this VersionedReportingTask. The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task.

Returns:

The annotation_data of this VersionedReportingTask.

Return type:

str

attribute_map = {'annotation_data': 'annotationData', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'scheduled_state': 'scheduledState', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'type': 'type'}

property bundle

Gets the bundle of this VersionedReportingTask.

Returns:

The bundle of this VersionedReportingTask.

Return type:

Bundle

property comments

Gets the comments of this VersionedReportingTask. The user-supplied comments for the component

Returns:

The comments of this VersionedReportingTask.

Return type:

str

property component_type

Gets the component_type of this VersionedReportingTask.

Returns:

The component_type of this VersionedReportingTask.

Return type:

str

property group_identifier

Gets the group_identifier of this VersionedReportingTask. The ID of the Process Group that this component belongs to

Returns:

The group_identifier of this VersionedReportingTask.

Return type:

str

property identifier

Gets the identifier of this VersionedReportingTask. The component’s unique identifier

Returns:

The identifier of this VersionedReportingTask.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedReportingTask.

Return type:

str

property name

Gets the name of this VersionedReportingTask. The component’s name

Returns:

The name of this VersionedReportingTask.

Return type:

str

property position

Gets the position of this VersionedReportingTask.

Returns:

The position of this VersionedReportingTask.

Return type:

Position

property properties

Gets the properties of this VersionedReportingTask. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:

The properties of this VersionedReportingTask.

Return type:

dict(str, str)

property property_descriptors

Gets the property_descriptors of this VersionedReportingTask. The property descriptors for the component.

Returns:

The property_descriptors of this VersionedReportingTask.

Return type:

dict(str, VersionedPropertyDescriptor)

property scheduled_state

Gets the scheduled_state of this VersionedReportingTask. Indicates the scheduled state for the Reporting Task

Returns:

The scheduled_state of this VersionedReportingTask.

Return type:

str

property scheduling_period

Gets the scheduling_period of this VersionedReportingTask. The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy.

Returns:

The scheduling_period of this VersionedReportingTask.

Return type:

str

property scheduling_strategy

Gets the scheduling_strategy of this VersionedReportingTask. Indicates scheduling strategy that should dictate how the reporting task is triggered.

Returns:

The scheduling_strategy of this VersionedReportingTask.

Return type:

str

swagger_types = {'annotation_data': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'scheduled_state': 'str', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this VersionedReportingTask. The type of the extension component

Returns:

The type of this VersionedReportingTask.

Return type:

str

class nipyapi.nifi.models.VersionedReportingTaskImportRequestEntity(disconnected_node_acknowledged=None, reporting_task_snapshot=None)

Bases: object

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

VersionedReportingTaskImportRequestEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(disconnected_node_acknowledged=None, reporting_task_snapshot=None)

VersionedReportingTaskImportRequestEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'disconnected_node_acknowledged': 'disconnectedNodeAcknowledged', 'reporting_task_snapshot': 'reportingTaskSnapshot'}

property disconnected_node_acknowledged

Gets the disconnected_node_acknowledged of this VersionedReportingTaskImportRequestEntity. The disconnected node acknowledged flag

Returns:

The disconnected_node_acknowledged of this VersionedReportingTaskImportRequestEntity.

Return type:

bool

property reporting_task_snapshot

Gets the reporting_task_snapshot of this VersionedReportingTaskImportRequestEntity.

Returns:

The reporting_task_snapshot of this VersionedReportingTaskImportRequestEntity.

Return type:

VersionedReportingTaskSnapshot

swagger_types = {'disconnected_node_acknowledged': 'bool', 'reporting_task_snapshot': 'VersionedReportingTaskSnapshot'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedReportingTaskImportResponseEntity(controller_services=None, reporting_tasks=None)

Bases: object

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

VersionedReportingTaskImportResponseEntity - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_services=None, reporting_tasks=None)

VersionedReportingTaskImportResponseEntity - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_services': 'controllerServices', 'reporting_tasks': 'reportingTasks'}

property controller_services

Gets the controller_services of this VersionedReportingTaskImportResponseEntity. The controller services created by the import

Returns:

The controller_services of this VersionedReportingTaskImportResponseEntity.

Return type:

list[ControllerServiceEntity]

property reporting_tasks

Gets the reporting_tasks of this VersionedReportingTaskImportResponseEntity. The reporting tasks created by the import

Returns:

The reporting_tasks of this VersionedReportingTaskImportResponseEntity.

Return type:

list[ReportingTaskEntity]

swagger_types = {'controller_services': 'list[ControllerServiceEntity]', 'reporting_tasks': 'list[ReportingTaskEntity]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedReportingTaskSnapshot(controller_services=None, reporting_tasks=None)

Bases: object

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

VersionedReportingTaskSnapshot - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(controller_services=None, reporting_tasks=None)

VersionedReportingTaskSnapshot - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'controller_services': 'controllerServices', 'reporting_tasks': 'reportingTasks'}

property controller_services

Gets the controller_services of this VersionedReportingTaskSnapshot. The controller services

Returns:

The controller_services of this VersionedReportingTaskSnapshot.

Return type:

list[VersionedControllerService]

property reporting_tasks

Gets the reporting_tasks of this VersionedReportingTaskSnapshot. The reporting tasks

Returns:

The reporting_tasks of this VersionedReportingTaskSnapshot.

Return type:

list[VersionedReportingTask]

swagger_types = {'controller_services': 'list[VersionedControllerService]', 'reporting_tasks': 'list[VersionedReportingTask]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.nifi.models.VersionedResourceDefinition(cardinality=None, resource_types=None)

Bases: object

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

VersionedResourceDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cardinality=None, resource_types=None)

VersionedResourceDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cardinality': 'cardinality', 'resource_types': 'resourceTypes'}

property cardinality

Gets the cardinality of this VersionedResourceDefinition. The cardinality of the resource

Returns:

The cardinality of this VersionedResourceDefinition.

Return type:

str

property resource_types

Gets the resource_types of this VersionedResourceDefinition. The types of resource that the Property Descriptor is allowed to reference

Returns:

The resource_types of this VersionedResourceDefinition.

Return type:

list[str]

swagger_types = {'cardinality': 'str', 'resource_types': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model