nipyapi.registry.models package

Submodules

nipyapi.registry.models.access_policy module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.access_policy.AccessPolicy(identifier=None, resource=None, action=None, configurable=None, revision=None, users=None, user_groups=None)

Bases: object

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

AccessPolicy - a model defined in Swagger

action

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

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

attribute_map = {'action': 'action', 'configurable': 'configurable', 'identifier': 'identifier', 'resource': 'resource', 'revision': 'revision', 'user_groups': 'userGroups', 'users': 'users'}

configurable

Gets the configurable of this AccessPolicy. Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.

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

identifier

Gets the identifier of this AccessPolicy. The id of the policy. Set by server at creation time.

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

resource

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

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

revision

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

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

swagger_types = {'action': 'str', 'configurable': 'bool', 'identifier': 'str', 'resource': 'str', 'revision': 'RevisionInfo', 'user_groups': 'list[Tenant]', 'users': 'list[Tenant]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

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

Returns:The user_groups of this AccessPolicy. Return type:list[Tenant]

users

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

Returns:The users of this AccessPolicy. Return type:list[Tenant]

nipyapi.registry.models.access_policy_summary module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.access_policy_summary.AccessPolicySummary(identifier=None, resource=None, action=None, configurable=None, revision=None)

Bases: object

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

AccessPolicySummary - a model defined in Swagger

action

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

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

attribute_map = {'action': 'action', 'configurable': 'configurable', 'identifier': 'identifier', 'resource': 'resource', 'revision': 'revision'}

configurable

Gets the configurable of this AccessPolicySummary. Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.

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

identifier

Gets the identifier of this AccessPolicySummary. The id of the policy. Set by server at creation time.

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

resource

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

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

revision

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

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

swagger_types = {'action': 'str', 'configurable': 'bool', 'identifier': 'str', 'resource': 'str', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.batch_size module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

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

Bases: object

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

BatchSize - a model defined in Swagger

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

count

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

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

duration

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

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

size

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

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

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.bucket module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

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

Bases: object

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

Bucket - a model defined in Swagger

allow_bundle_redeploy

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

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

allow_public_read

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

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

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

created_timestamp

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

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

description

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

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

identifier

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

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

link

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

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

name

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

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

permissions

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

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

revision

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

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

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.bucket_item module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.bucket_item.BucketItem(link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None)

Bases: object

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

BucketItem - a model defined in Swagger

attribute_map = {'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'modified_timestamp': 'modifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'type': 'type'}

bucket_identifier

Gets the bucket_identifier of this BucketItem. The identifier of the bucket this items belongs to. This cannot be changed after the item is created.

Returns:The bucket_identifier of this BucketItem. Return type:str

bucket_name

Gets the bucket_name of this BucketItem. The name of the bucket this items belongs to.

Returns:The bucket_name of this BucketItem. Return type:str

created_timestamp

Gets the created_timestamp of this BucketItem. The timestamp of when the item was created, as milliseconds since epoch.

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

description

Gets the description of this BucketItem. A description of the item.

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

identifier

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

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

link

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

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

modified_timestamp

Gets the modified_timestamp of this BucketItem. The timestamp of when the item was last modified, as milliseconds since epoch.

Returns:The modified_timestamp of this BucketItem. Return type:int

name

Gets the name of this BucketItem. The name of the item.

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

permissions

Gets the permissions of this BucketItem. The access that the current user has to the bucket containing this item.

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

swagger_types = {'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'modified_timestamp': 'int', 'name': 'str', 'permissions': 'Permissions', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this BucketItem. The type of item.

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

nipyapi.registry.models.bundle module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

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

Bases: object

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

Bundle - a model defined in Swagger

artifact

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

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

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

group

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

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

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

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

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

nipyapi.registry.models.connectable_component module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

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

Bases: object

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

ConnectableComponent - a model defined in Swagger

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

comments

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

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

group_id

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

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

id

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

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

instance_identifier

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

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

name

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

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

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

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

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

nipyapi.registry.models.controller_service_api module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

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

Bases: object

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

ControllerServiceAPI - a model defined in Swagger

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

bundle

Gets the bundle of this ControllerServiceAPI. The details of the artifact that bundled this service interface.

Returns:The bundle of this ControllerServiceAPI. Return type:Bundle

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

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

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

nipyapi.registry.models.current_user module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.current_user.CurrentUser(identity=None, anonymous=None, login_supported=None, resource_permissions=None, oidclogin_supported=None)

Bases: object

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

CurrentUser - a model defined in Swagger

anonymous

Gets the anonymous of this CurrentUser. Indicates if the current user is anonymous

Returns:The anonymous of this CurrentUser. Return type:bool

attribute_map = {'anonymous': 'anonymous', 'identity': 'identity', 'login_supported': 'loginSupported', 'oidclogin_supported': 'oidcloginSupported', 'resource_permissions': 'resourcePermissions'}

identity

Gets the identity of this CurrentUser. The identity of the current user

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

login_supported

Gets the login_supported of this CurrentUser. Indicates if the NiFi Registry instance supports logging in

Returns:The login_supported of this CurrentUser. Return type:bool

oidclogin_supported

Gets the oidclogin_supported of this CurrentUser. Indicates if the NiFi Registry instance supports logging in with an OIDC provider

Returns:The oidclogin_supported of this CurrentUser. Return type:bool

resource_permissions

Gets the resource_permissions of this CurrentUser. The access that the current user has to top level resources

Returns:The resource_permissions of this CurrentUser. Return type:ResourcePermissions

swagger_types = {'anonymous': 'bool', 'identity': 'str', 'login_supported': 'bool', 'oidclogin_supported': 'bool', 'resource_permissions': 'ResourcePermissions'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.fields module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.fields.Fields(fields=None)

Bases: object

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

Fields - a model defined in Swagger

attribute_map = {'fields': 'fields'}

fields

Gets the fields of this Fields.

Returns:The fields of this Fields. Return type:list[str]

swagger_types = {'fields': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.permissions module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.permissions.Permissions(can_read=None, can_write=None, can_delete=None)

Bases: object

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

Permissions - a model defined in Swagger

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

can_delete

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

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

can_read

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

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

can_write

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

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

swagger_types = {'can_delete': 'bool', 'can_read': 'bool', 'can_write': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.resource module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.resource.Resource(identifier=None, name=None)

Bases: object

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

Resource - a model defined in Swagger

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

identifier

Gets the identifier of this Resource. The identifier of the resource.

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

name

Gets the name of this Resource. The name of the resource.

Returns:The name of this Resource. 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

nipyapi.registry.models.resource_permissions module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.resource_permissions.ResourcePermissions(buckets=None, tenants=None, policies=None, proxy=None, any_top_level_resource=None)

Bases: object

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

ResourcePermissions - a model defined in Swagger

any_top_level_resource

Gets the any_top_level_resource of this ResourcePermissions. The access that the current user has to any top level resources (a logical ‘OR’ of all other values)

Returns:The any_top_level_resource of this ResourcePermissions. Return type:Permissions

attribute_map = {'any_top_level_resource': 'anyTopLevelResource', 'buckets': 'buckets', 'policies': 'policies', 'proxy': 'proxy', 'tenants': 'tenants'}

buckets

Gets the buckets of this ResourcePermissions. The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)

Returns:The buckets of this ResourcePermissions. Return type:Permissions

policies

Gets the policies of this ResourcePermissions. The access that the current user has to the top level /policies resource of this NiFi Registry

Returns:The policies of this ResourcePermissions. Return type:Permissions

proxy

Gets the proxy of this ResourcePermissions. The access that the current user has to the top level /proxy resource of this NiFi Registry

Returns:The proxy of this ResourcePermissions. Return type:Permissions

swagger_types = {'any_top_level_resource': 'Permissions', 'buckets': 'Permissions', 'policies': 'Permissions', 'proxy': 'Permissions', 'tenants': 'Permissions'}

tenants

Gets the tenants of this ResourcePermissions. The access that the current user has to the top level /tenants resource of this NiFi Registry

Returns:The tenants of this ResourcePermissions. Return type:Permissions

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.tenant module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.tenant.Tenant(identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None)

Bases: object

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

Tenant - a model defined in Swagger

access_policies

Gets the access_policies of this Tenant. The access policies granted to this tenant.

Returns:The access_policies of this Tenant. Return type:list[AccessPolicySummary]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'identifier': 'identifier', 'identity': 'identity', 'resource_permissions': 'resourcePermissions', 'revision': 'revision'}

configurable

Gets the configurable of this Tenant. Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.

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

identifier

Gets the identifier of this Tenant. The computer-generated identifier of the tenant.

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

identity

Gets the identity of this Tenant. The human-facing identity of the tenant. This can only be changed if the tenant is configurable.

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

resource_permissions

Gets the resource_permissions of this Tenant. A summary top-level resource access policies granted to this tenant.

Returns:The resource_permissions of this Tenant. Return type:ResourcePermissions

revision

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

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

swagger_types = {'access_policies': 'list[AccessPolicySummary]', 'configurable': 'bool', 'identifier': 'str', 'identity': 'str', 'resource_permissions': 'ResourcePermissions', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.user module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.user.User(identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, user_groups=None)

Bases: object

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

User - a model defined in Swagger

access_policies

Gets the access_policies of this User. The access policies granted to this tenant.

Returns:The access_policies of this User. Return type:list[AccessPolicySummary]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'identifier': 'identifier', 'identity': 'identity', 'resource_permissions': 'resourcePermissions', 'revision': 'revision', 'user_groups': 'userGroups'}

configurable

Gets the configurable of this User. Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.

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

identifier

Gets the identifier of this User. The computer-generated identifier of the tenant.

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

identity

Gets the identity of this User. The human-facing identity of the tenant. This can only be changed if the tenant is configurable.

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

resource_permissions

Gets the resource_permissions of this User. A summary top-level resource access policies granted to this tenant.

Returns:The resource_permissions of this User. Return type:ResourcePermissions

revision

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

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

swagger_types = {'access_policies': 'list[AccessPolicySummary]', 'configurable': 'bool', 'identifier': 'str', 'identity': 'str', 'resource_permissions': 'ResourcePermissions', 'revision': 'RevisionInfo', 'user_groups': 'list[Tenant]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

user_groups

Gets the user_groups of this User. The groups to which the user belongs.

Returns:The user_groups of this User. Return type:list[Tenant]

nipyapi.registry.models.user_group module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.user_group.UserGroup(identifier=None, identity=None, configurable=None, resource_permissions=None, access_policies=None, revision=None, users=None)

Bases: object

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

UserGroup - a model defined in Swagger

access_policies

Gets the access_policies of this UserGroup. The access policies granted to this tenant.

Returns:The access_policies of this UserGroup. Return type:list[AccessPolicySummary]

attribute_map = {'access_policies': 'accessPolicies', 'configurable': 'configurable', 'identifier': 'identifier', 'identity': 'identity', 'resource_permissions': 'resourcePermissions', 'revision': 'revision', 'users': 'users'}

configurable

Gets the configurable of this UserGroup. Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.

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

identifier

Gets the identifier of this UserGroup. The computer-generated identifier of the tenant.

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

identity

Gets the identity of this UserGroup. The human-facing identity of the tenant. This can only be changed if the tenant is configurable.

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

resource_permissions

Gets the resource_permissions of this UserGroup. A summary top-level resource access policies granted to this tenant.

Returns:The resource_permissions of this UserGroup. Return type:ResourcePermissions

revision

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

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

swagger_types = {'access_policies': 'list[AccessPolicySummary]', 'configurable': 'bool', 'identifier': 'str', 'identity': 'str', 'resource_permissions': 'ResourcePermissions', 'revision': 'RevisionInfo', 'users': 'list[Tenant]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

users

Gets the users of this UserGroup. The users that belong to this user group. This can only be changed if this group is configurable.

Returns:The users of this UserGroup. Return type:list[Tenant]

nipyapi.registry.models.versioned_connection module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_connection.VersionedConnection(identifier=None, instance_identifier=None, name=None, comments=None, position=None, source=None, destination=None, label_index=None, z_index=None, selected_relationships=None, back_pressure_object_threshold=None, back_pressure_data_size_threshold=None, flow_file_expiration=None, prioritizers=None, bends=None, load_balance_strategy=None, partitioning_attribute=None, load_balance_compression=None, component_type=None, group_identifier=None)

Bases: object

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

VersionedConnection - a model defined in Swagger

attribute_map = {'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'comments': 'comments', 'component_type': 'componentType', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', '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'}

back_pressure_data_size_threshold

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

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

back_pressure_object_threshold

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

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

bends

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

Returns:The bends of this VersionedConnection. Return type:list[Position]

comments

Gets the comments of this VersionedConnection. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedConnection.

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

destination

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

Returns:The destination of this VersionedConnection. Return type:ConnectableComponent

flow_file_expiration

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

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

group_identifier

Gets the group_identifier of this VersionedConnection. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedConnection. Return type:str

identifier

Gets the identifier of this VersionedConnection. The component’s unique identifier

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

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

label_index

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

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

load_balance_compression

Gets the load_balance_compression of this VersionedConnection. Whether or not compression should be used when transferring FlowFiles between nodes

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

load_balance_strategy

Gets the load_balance_strategy of this VersionedConnection. The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.

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

name

Gets the name of this VersionedConnection. The component’s name

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

partitioning_attribute

Gets the partitioning_attribute of this VersionedConnection. The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.

Returns:The partitioning_attribute of this VersionedConnection. Return type:str

position

Gets the position of this VersionedConnection. The component’s position on the graph

Returns:The position of this VersionedConnection. Return type:Position

prioritizers

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

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

selected_relationships

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

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

source

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

Returns:The source of this VersionedConnection. Return type:ConnectableComponent

swagger_types = {'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[Position]', 'comments': 'str', 'component_type': 'str', 'destination': 'ConnectableComponent', 'flow_file_expiration': 'str', 'group_identifier': 'str', 'identifier': 'str', '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

z_index

Gets the z_index of this VersionedConnection. The z index of the connection.

Returns:The z_index of this VersionedConnection. Return type:int

nipyapi.registry.models.versioned_controller_service module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_controller_service.VersionedControllerService(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, controller_service_apis=None, annotation_data=None, scheduled_state=None, bulletin_level=None, component_type=None, group_identifier=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

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

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

bundle

Gets the bundle of this VersionedControllerService. Information about the bundle from which the component came

Returns:The bundle of this VersionedControllerService. Return type:Bundle

comments

Gets the comments of this VersionedControllerService. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedControllerService.

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

controller_service_apis

Gets the controller_service_apis of this VersionedControllerService. Lists the APIs this Controller Service implements.

Returns:The controller_service_apis of this VersionedControllerService. Return type:list[ControllerServiceAPI]

group_identifier

Gets the group_identifier of this VersionedControllerService. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedControllerService. Return type:str

identifier

Gets the identifier of this VersionedControllerService. The component’s unique identifier

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

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

name

Gets the name of this VersionedControllerService. The component’s name

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

position

Gets the position of this VersionedControllerService. The component’s position on the graph

Returns:The position of this VersionedControllerService. Return type:Position

properties

Gets the properties of this VersionedControllerService. The properties 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_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)

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

type

Gets the type of this VersionedControllerService. The type of the extension component

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

nipyapi.registry.models.versioned_flow module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_flow.VersionedFlow(link=None, identifier=None, name=None, description=None, bucket_identifier=None, bucket_name=None, created_timestamp=None, modified_timestamp=None, type=None, permissions=None, version_count=None, revision=None)

Bases: object

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

VersionedFlow - a model defined in Swagger

attribute_map = {'bucket_identifier': 'bucketIdentifier', 'bucket_name': 'bucketName', 'created_timestamp': 'createdTimestamp', 'description': 'description', 'identifier': 'identifier', 'link': 'link', 'modified_timestamp': 'modifiedTimestamp', 'name': 'name', 'permissions': 'permissions', 'revision': 'revision', 'type': 'type', 'version_count': 'versionCount'}

bucket_identifier

Gets the bucket_identifier of this VersionedFlow. The identifier of the bucket this items belongs to. This cannot be changed after the item is created.

Returns:The bucket_identifier of this VersionedFlow. Return type:str

bucket_name

Gets the bucket_name of this VersionedFlow. The name of the bucket this items belongs to.

Returns:The bucket_name of this VersionedFlow. Return type:str

created_timestamp

Gets the created_timestamp of this VersionedFlow. The timestamp of when the item was created, as milliseconds since epoch.

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

description

Gets the description of this VersionedFlow. A description of the item.

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

identifier

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

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

link

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

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

modified_timestamp

Gets the modified_timestamp of this VersionedFlow. The timestamp of when the item was last modified, as milliseconds since epoch.

Returns:The modified_timestamp of this VersionedFlow. Return type:int

name

Gets the name of this VersionedFlow. The name of the item.

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

permissions

Gets the permissions of this VersionedFlow. The access that the current user has to the bucket containing this item.

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

revision

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

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

swagger_types = {'bucket_identifier': 'str', 'bucket_name': 'str', 'created_timestamp': 'int', 'description': 'str', 'identifier': 'str', 'link': 'JaxbLink', 'modified_timestamp': 'int', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo', 'type': 'str', 'version_count': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

type

Gets the type of this VersionedFlow. The type of item.

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

version_count

Gets the version_count of this VersionedFlow. The number of versions of this flow.

Returns:The version_count of this VersionedFlow. Return type:int

nipyapi.registry.models.versioned_flow_coordinates module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_flow_coordinates.VersionedFlowCoordinates(registry_id=None, storage_location=None, registry_url=None, bucket_id=None, flow_id=None, version=None, latest=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

attribute_map = {'bucket_id': 'bucketId', 'flow_id': 'flowId', 'latest': 'latest', 'registry_id': 'registryId', 'registry_url': 'registryUrl', 'storage_location': 'storageLocation', 'version': 'version'}

bucket_id

Gets the bucket_id of this VersionedFlowCoordinates. The UUID of the bucket that the flow resides in

Returns:The bucket_id of this VersionedFlowCoordinates. Return type:str

flow_id

Gets the flow_id of this VersionedFlowCoordinates. The UUID of the flow

Returns:The flow_id of this VersionedFlowCoordinates. Return type:str

latest

Gets the latest of this VersionedFlowCoordinates. Whether or not these coordinates point to the latest version of the flow

Returns:The latest of this VersionedFlowCoordinates. Return type:bool

registry_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

registry_url

Gets the registry_url of this VersionedFlowCoordinates. The URL of the Flow Registry that contains the flow

Returns:The registry_url of this VersionedFlowCoordinates. Return type:str

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 = {'bucket_id': 'str', 'flow_id': 'str', 'latest': 'bool', 'registry_id': 'str', 'registry_url': 'str', 'storage_location': 'str', 'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this VersionedFlowCoordinates. The version of the flow

Returns:The version of this VersionedFlowCoordinates. Return type:int

nipyapi.registry.models.versioned_flow_snapshot module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_flow_snapshot.VersionedFlowSnapshot(snapshot_metadata=None, flow_contents=None, external_controller_services=None, parameter_providers=None, parameter_contexts=None, flow_encoding_version=None, flow=None, bucket=None, latest=None)

Bases: object

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

VersionedFlowSnapshot - a model defined in Swagger

attribute_map = {'bucket': 'bucket', 'external_controller_services': 'externalControllerServices', 'flow': 'flow', 'flow_contents': 'flowContents', 'flow_encoding_version': 'flowEncodingVersion', 'latest': 'latest', 'parameter_contexts': 'parameterContexts', 'parameter_providers': 'parameterProviders', 'snapshot_metadata': 'snapshotMetadata'}

bucket

Gets the bucket of this VersionedFlowSnapshot. The bucket where the flow is located

Returns:The bucket of this VersionedFlowSnapshot. Return type:Bucket

external_controller_services

Gets the external_controller_services of this VersionedFlowSnapshot. The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.

Returns:The external_controller_services of this VersionedFlowSnapshot. Return type:dict(str, ExternalControllerServiceReference)

flow

Gets the flow of this VersionedFlowSnapshot. The flow this snapshot is for

Returns:The flow of this VersionedFlowSnapshot. Return type:VersionedFlow

flow_contents

Gets the flow_contents of this VersionedFlowSnapshot. The contents of the versioned flow

Returns:The flow_contents of this VersionedFlowSnapshot. Return type:VersionedProcessGroup

flow_encoding_version

Gets the flow_encoding_version of this VersionedFlowSnapshot. The optional encoding version of the flow contents.

Returns:The flow_encoding_version of this VersionedFlowSnapshot. Return type:str

latest

Gets the latest of this VersionedFlowSnapshot.

Returns:The latest of this VersionedFlowSnapshot. Return type:bool

parameter_contexts

Gets the parameter_contexts of this VersionedFlowSnapshot. The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.

Returns:The parameter_contexts of this VersionedFlowSnapshot. Return type:dict(str, VersionedParameterContext)

parameter_providers

Gets the parameter_providers of this VersionedFlowSnapshot. Contains basic information about parameter providers referenced in the versioned flow.

Returns:The parameter_providers of this VersionedFlowSnapshot. Return type:dict(str, ParameterProviderReference)

snapshot_metadata

Gets the snapshot_metadata of this VersionedFlowSnapshot. The metadata for this snapshot

Returns:The snapshot_metadata of this VersionedFlowSnapshot. Return type:VersionedFlowSnapshotMetadata

swagger_types = {'bucket': 'Bucket', 'external_controller_services': 'dict(str, ExternalControllerServiceReference)', 'flow': 'VersionedFlow', 'flow_contents': 'VersionedProcessGroup', 'flow_encoding_version': 'str', 'latest': 'bool', 'parameter_contexts': 'dict(str, VersionedParameterContext)', 'parameter_providers': 'dict(str, ParameterProviderReference)', 'snapshot_metadata': 'VersionedFlowSnapshotMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.versioned_flow_snapshot_metadata module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_flow_snapshot_metadata.VersionedFlowSnapshotMetadata(link=None, bucket_identifier=None, flow_identifier=None, version=None, timestamp=None, author=None, comments=None)

Bases: object

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

VersionedFlowSnapshotMetadata - a model defined in Swagger

attribute_map = {'author': 'author', 'bucket_identifier': 'bucketIdentifier', 'comments': 'comments', 'flow_identifier': 'flowIdentifier', 'link': 'link', 'timestamp': 'timestamp', 'version': 'version'}

author

Gets the author of this VersionedFlowSnapshotMetadata. The user that created this snapshot of the flow.

Returns:The author of this VersionedFlowSnapshotMetadata. Return type:str

bucket_identifier

Gets the bucket_identifier of this VersionedFlowSnapshotMetadata. The identifier of the bucket this snapshot belongs to.

Returns:The bucket_identifier of this VersionedFlowSnapshotMetadata. Return type:str

comments

Gets the comments of this VersionedFlowSnapshotMetadata. The comments provided by the user when creating the snapshot.

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

flow_identifier

Gets the flow_identifier of this VersionedFlowSnapshotMetadata. The identifier of the flow this snapshot belongs to.

Returns:The flow_identifier of this VersionedFlowSnapshotMetadata. Return type:str

link

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

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

swagger_types = {'author': 'str', 'bucket_identifier': 'str', 'comments': 'str', 'flow_identifier': 'str', 'link': 'JaxbLink', 'timestamp': 'int', 'version': 'int'}

timestamp

Gets the timestamp of this VersionedFlowSnapshotMetadata. The timestamp when the flow was saved, as milliseconds since epoch.

Returns:The timestamp of this VersionedFlowSnapshotMetadata. Return type:int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

version

Gets the version of this VersionedFlowSnapshotMetadata. The version of this snapshot of the flow.

Returns:The version of this VersionedFlowSnapshotMetadata. Return type:int

nipyapi.registry.models.versioned_funnel module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_funnel.VersionedFunnel(identifier=None, instance_identifier=None, name=None, comments=None, position=None, component_type=None, group_identifier=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

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position'}

comments

Gets the comments of this VersionedFunnel. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedFunnel.

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

group_identifier

Gets the group_identifier of this VersionedFunnel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedFunnel. Return type:str

identifier

Gets the identifier of this VersionedFunnel. The component’s unique identifier

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

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

name

Gets the name of this VersionedFunnel. The component’s name

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

position

Gets the position of this VersionedFunnel. The component’s position on the graph

Returns:The position of this VersionedFunnel. Return type:Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', '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

nipyapi.registry.models.versioned_label module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_label.VersionedLabel(identifier=None, instance_identifier=None, name=None, comments=None, position=None, label=None, z_index=None, width=None, height=None, style=None, component_type=None, group_identifier=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

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

comments

Gets the comments of this VersionedLabel. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedLabel.

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

group_identifier

Gets the group_identifier of this VersionedLabel. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedLabel. Return type:str

height

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

Returns:The height of this VersionedLabel. Return type:float

identifier

Gets the identifier of this VersionedLabel. The component’s unique identifier

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

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

label

Gets the label of this VersionedLabel. The text that appears in the label.

Returns:The label of this VersionedLabel. Return type:str

name

Gets the name of this VersionedLabel. The component’s name

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

position

Gets the position of this VersionedLabel. The component’s position on the graph

Returns:The position of this VersionedLabel. Return type:Position

style

Gets the style of this VersionedLabel. The styles for this label (font-size : 12px, background-color : #eee, etc).

Returns:The style of this VersionedLabel. Return type:dict(str, str)

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'height': 'float', 'identifier': 'str', '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

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

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

nipyapi.registry.models.versioned_port module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_port.VersionedPort(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, concurrently_schedulable_task_count=None, scheduled_state=None, allow_remote_access=None, component_type=None, group_identifier=None)

Bases: object

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

VersionedPort - a model defined in Swagger

allow_remote_access

Gets the allow_remote_access of this VersionedPort. Whether or not this port allows remote access for site-to-site

Returns:The allow_remote_access of this VersionedPort. Return type:bool

attribute_map = {'allow_remote_access': 'allowRemoteAccess', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'scheduled_state': 'scheduledState', 'type': 'type'}

comments

Gets the comments of this VersionedPort. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedPort.

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

concurrently_schedulable_task_count

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

Returns:The concurrently_schedulable_task_count of this VersionedPort. Return type:int

group_identifier

Gets the group_identifier of this VersionedPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedPort. Return type:str

identifier

Gets the identifier of this VersionedPort. The component’s unique identifier

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

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

name

Gets the name of this VersionedPort. The component’s name

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

position

Gets the position of this VersionedPort. The component’s position on the graph

Returns:The position of this VersionedPort. Return type:Position

scheduled_state

Gets the scheduled_state of this VersionedPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedPort. Return type:str

swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': '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

type

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

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

nipyapi.registry.models.versioned_process_group module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_process_group.VersionedProcessGroup(identifier=None, instance_identifier=None, name=None, comments=None, position=None, process_groups=None, remote_process_groups=None, processors=None, input_ports=None, output_ports=None, connections=None, labels=None, funnels=None, controller_services=None, versioned_flow_coordinates=None, variables=None, parameter_context_name=None, default_flow_file_expiration=None, default_back_pressure_object_threshold=None, default_back_pressure_data_size_threshold=None, flow_file_concurrency=None, flow_file_outbound_policy=None, component_type=None, group_identifier=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

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', 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', 'funnels': 'funnels', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'labels': 'labels', 'name': 'name', 'output_ports': 'outputPorts', 'parameter_context_name': 'parameterContextName', 'position': 'position', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'variables': 'variables', 'versioned_flow_coordinates': 'versionedFlowCoordinates'}

comments

Gets the comments of this VersionedProcessGroup. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedProcessGroup.

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

connections

Gets the connections of this VersionedProcessGroup. The Connections

Returns:The connections of this VersionedProcessGroup. Return type:list[VersionedConnection]

controller_services

Gets the controller_services of this VersionedProcessGroup. The Controller Services

Returns:The controller_services of this VersionedProcessGroup. Return type:list[VersionedControllerService]

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

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

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

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

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

funnels

Gets the funnels of this VersionedProcessGroup. The Funnels

Returns:The funnels of this VersionedProcessGroup. Return type:list[VersionedFunnel]

group_identifier

Gets the group_identifier of this VersionedProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessGroup. Return type:str

identifier

Gets the identifier of this VersionedProcessGroup. The component’s unique identifier

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

input_ports

Gets the input_ports of this VersionedProcessGroup. The Input Ports

Returns:The input_ports of this VersionedProcessGroup. Return type:list[VersionedPort]

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

labels

Gets the labels of this VersionedProcessGroup. The Labels

Returns:The labels of this VersionedProcessGroup. Return type:list[VersionedLabel]

name

Gets the name of this VersionedProcessGroup. The component’s name

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

output_ports

Gets the output_ports of this VersionedProcessGroup. The Output Ports

Returns:The output_ports of this VersionedProcessGroup. Return type:list[VersionedPort]

parameter_context_name

Gets the parameter_context_name of this VersionedProcessGroup. The name of the parameter context used by this process group

Returns:The parameter_context_name of this VersionedProcessGroup. Return type:str

position

Gets the position of this VersionedProcessGroup. The component’s position on the graph

Returns:The position of this VersionedProcessGroup. Return type:Position

process_groups

Gets the process_groups of this VersionedProcessGroup. The child Process Groups

Returns:The process_groups of this VersionedProcessGroup. Return type:list[VersionedProcessGroup]

processors

Gets the processors of this VersionedProcessGroup. The Processors

Returns:The processors of this VersionedProcessGroup. Return type:list[VersionedProcessor]

remote_process_groups

Gets the remote_process_groups of this VersionedProcessGroup. The Remote Process Groups

Returns:The remote_process_groups of this VersionedProcessGroup. Return type:list[VersionedRemoteProcessGroup]

swagger_types = {'comments': 'str', 'component_type': 'str', 'connections': 'list[VersionedConnection]', 'controller_services': 'list[VersionedControllerService]', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': '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]', 'name': 'str', 'output_ports': 'list[VersionedPort]', 'parameter_context_name': 'str', 'position': 'Position', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', 'variables': 'dict(str, str)', 'versioned_flow_coordinates': 'VersionedFlowCoordinates'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

variables

Gets the variables of this VersionedProcessGroup. The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)

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

versioned_flow_coordinates

Gets the versioned_flow_coordinates of this VersionedProcessGroup. The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control

Returns:The versioned_flow_coordinates of this VersionedProcessGroup. Return type:VersionedFlowCoordinates

nipyapi.registry.models.versioned_processor module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_processor.VersionedProcessor(identifier=None, instance_identifier=None, name=None, comments=None, position=None, type=None, bundle=None, properties=None, property_descriptors=None, style=None, annotation_data=None, scheduling_period=None, scheduling_strategy=None, execution_node=None, penalty_duration=None, yield_duration=None, bulletin_level=None, run_duration_millis=None, concurrently_schedulable_task_count=None, auto_terminated_relationships=None, scheduled_state=None, retry_count=None, retried_relationships=None, backoff_mechanism=None, max_backoff_period=None, component_type=None, group_identifier=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

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

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]

backoff_mechanism

Gets the backoff_mechanism of this VersionedProcessor. Determines whether the FlowFile should be penalized or the processor should be yielded between retries.

Returns:The backoff_mechanism of this VersionedProcessor. Return type:str

bulletin_level

Gets the bulletin_level of this VersionedProcessor. The level at which the processor will report bulletins.

Returns:The bulletin_level of this VersionedProcessor. Return type:str

bundle

Gets the bundle of this VersionedProcessor. Information about the bundle from which the component came

Returns:The bundle of this VersionedProcessor. Return type:Bundle

comments

Gets the comments of this VersionedProcessor. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedProcessor.

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

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedProcessor. The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.

Returns:The concurrently_schedulable_task_count of this VersionedProcessor. Return type:int

execution_node

Gets the execution_node of this VersionedProcessor. Indicates the node where the process will execute.

Returns:The execution_node of this VersionedProcessor. Return type:str

group_identifier

Gets the group_identifier of this VersionedProcessor. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedProcessor. Return type:str

identifier

Gets the identifier of this VersionedProcessor. The component’s unique identifier

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

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

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

name

Gets the name of this VersionedProcessor. The component’s name

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

penalty_duration

Gets the penalty_duration of this VersionedProcessor. The amout of time that is used when the process penalizes a flowfile.

Returns:The penalty_duration of this VersionedProcessor. Return type:str

position

Gets the position of this VersionedProcessor. The component’s position on the graph

Returns:The position of this VersionedProcessor. Return type:Position

properties

Gets the properties of this VersionedProcessor. The properties for the 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_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)

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]

retry_count

Gets the retry_count of this VersionedProcessor. Overall number of retries.

Returns:The retry_count of this VersionedProcessor. Return type:int

run_duration_millis

Gets the run_duration_millis of this VersionedProcessor. The run duration for the processor in milliseconds.

Returns:The run_duration_millis of this VersionedProcessor. Return type:int

scheduled_state

Gets the scheduled_state of this VersionedProcessor. The scheduled state of the component

Returns:The scheduled_state of this VersionedProcessor. Return type:str

scheduling_period

Gets the scheduling_period of this VersionedProcessor. The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.

Returns:The scheduling_period of this VersionedProcessor. Return type:str

scheduling_strategy

Gets the scheduling_strategy of this VersionedProcessor. Indicates whether the processor should be scheduled to run in event or timer driven mode.

Returns:The scheduling_strategy of this VersionedProcessor. Return type:str

style

Gets the style of this VersionedProcessor. Stylistic data for rendering in a UI

Returns:The style of this VersionedProcessor. Return type:dict(str, str)

swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', '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

type

Gets the type of this VersionedProcessor. The type of the extension component

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

yield_duration

Gets the yield_duration of this VersionedProcessor. The amount of time that must elapse before this processor is scheduled again after yielding.

Returns:The yield_duration of this VersionedProcessor. Return type:str

nipyapi.registry.models.versioned_property_descriptor module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_property_descriptor.VersionedPropertyDescriptor(name=None, display_name=None, identifies_controller_service=None, sensitive=None, resource_definition=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

attribute_map = {'display_name': 'displayName', 'identifies_controller_service': 'identifiesControllerService', 'name': 'name', 'resource_definition': 'resourceDefinition', 'sensitive': 'sensitive'}

display_name

Gets the display_name of this VersionedPropertyDescriptor. The display name of the property

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

identifies_controller_service

Gets the identifies_controller_service of this VersionedPropertyDescriptor. Whether or not the property provides the identifier of a Controller Service

Returns:The identifies_controller_service of this VersionedPropertyDescriptor. Return type:bool

name

Gets the name of this VersionedPropertyDescriptor. The name of the property

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

resource_definition

Gets the resource_definition of this VersionedPropertyDescriptor. Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any

Returns:The resource_definition of this VersionedPropertyDescriptor. Return type:VersionedResourceDefinition

sensitive

Gets the sensitive of this VersionedPropertyDescriptor. Whether or not the property is considered sensitive

Returns:The sensitive of this VersionedPropertyDescriptor. Return type:bool

swagger_types = {'display_name': 'str', 'identifies_controller_service': 'bool', 'name': 'str', 'resource_definition': 'VersionedResourceDefinition', 'sensitive': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

nipyapi.registry.models.versioned_remote_group_port module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_remote_group_port.VersionedRemoteGroupPort(identifier=None, instance_identifier=None, name=None, comments=None, position=None, remote_group_id=None, concurrently_schedulable_task_count=None, use_compression=None, batch_size=None, component_type=None, target_id=None, scheduled_state=None, group_identifier=None)

Bases: object

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

VersionedRemoteGroupPort - a model defined in Swagger

attribute_map = {'batch_size': 'batchSize', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'remote_group_id': 'remoteGroupId', 'scheduled_state': 'scheduledState', 'target_id': 'targetId', 'use_compression': 'useCompression'}

batch_size

Gets the batch_size of this VersionedRemoteGroupPort. The batch settings for data transmission.

Returns:The batch_size of this VersionedRemoteGroupPort. Return type:BatchSize

comments

Gets the comments of this VersionedRemoteGroupPort. The user-supplied comments for the component

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

component_type

Gets the component_type of this VersionedRemoteGroupPort.

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

concurrently_schedulable_task_count

Gets the concurrently_schedulable_task_count of this VersionedRemoteGroupPort. The number of task that may transmit flowfiles to the target port concurrently.

Returns:The concurrently_schedulable_task_count of this VersionedRemoteGroupPort. Return type:int

group_identifier

Gets the group_identifier of this VersionedRemoteGroupPort. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteGroupPort. Return type:str

identifier

Gets the identifier of this VersionedRemoteGroupPort. The component’s unique identifier

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

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

name

Gets the name of this VersionedRemoteGroupPort. The component’s name

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

position

Gets the position of this VersionedRemoteGroupPort. The component’s position on the graph

Returns:The position of this VersionedRemoteGroupPort. Return type:Position

remote_group_id

Gets the remote_group_id of this VersionedRemoteGroupPort. The id of the remote process group that the port resides in.

Returns:The remote_group_id of this VersionedRemoteGroupPort. Return type:str

scheduled_state

Gets the scheduled_state of this VersionedRemoteGroupPort. The scheduled state of the component

Returns:The scheduled_state of this VersionedRemoteGroupPort. Return type:str

swagger_types = {'batch_size': 'BatchSize', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'remote_group_id': 'str', 'scheduled_state': 'str', 'target_id': 'str', 'use_compression': 'bool'}

target_id

Gets the target_id of this VersionedRemoteGroupPort. The ID of the port on the target NiFi instance

Returns:The target_id of this VersionedRemoteGroupPort. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

use_compression

Gets the use_compression of this VersionedRemoteGroupPort. Whether the flowfiles are compressed when sent to the target port.

Returns:The use_compression of this VersionedRemoteGroupPort. Return type:bool

nipyapi.registry.models.versioned_remote_process_group module

Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

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

class nipyapi.registry.models.versioned_remote_process_group.VersionedRemoteProcessGroup(identifier=None, instance_identifier=None, name=None, comments=None, position=None, target_uri=None, target_uris=None, communications_timeout=None, yield_duration=None, transport_protocol=None, local_network_interface=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, input_ports=None, output_ports=None, component_type=None, group_identifier=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

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_uri': 'targetUri', 'target_uris': 'targetUris', 'transport_protocol': 'transportProtocol', 'yield_duration': 'yieldDuration'}

comments

Gets the comments of this VersionedRemoteProcessGroup. The user-supplied comments for the component

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

communications_timeout

Gets the communications_timeout of this VersionedRemoteProcessGroup. The time period used for the timeout when communicating with the target.

Returns:The communications_timeout of this VersionedRemoteProcessGroup. Return type:str

component_type

Gets the component_type of this VersionedRemoteProcessGroup.

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

group_identifier

Gets the group_identifier of this VersionedRemoteProcessGroup. The ID of the Process Group that this component belongs to

Returns:The group_identifier of this VersionedRemoteProcessGroup. Return type:str

identifier

Gets the identifier of this VersionedRemoteProcessGroup. The component’s unique identifier

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

input_ports

Gets the input_ports of this VersionedRemoteProcessGroup. A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance

Returns:The input_ports of this VersionedRemoteProcessGroup. Return type:list[VersionedRemoteGroupPort]

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

local_network_interface

Gets the local_network_interface of this VersionedRemoteProcessGroup. The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.

Returns:The local_network_interface of this VersionedRemoteProcessGroup. Return type:str

name

Gets the name of this VersionedRemoteProcessGroup. The component’s name

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

output_ports

Gets the output_ports of this VersionedRemoteProcessGroup. A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance

Returns:The output_ports of this VersionedRemoteProcessGroup. Return type:list[VersionedRemoteGroupPort]

position

Gets the position of this VersionedRemoteProcessGroup. The component’s position on the graph

Returns:The position of this VersionedRemoteProcessGroup. Return type:Position

proxy_host

Gets the proxy_host of this VersionedRemoteProcessGroup.

Returns:The proxy_host of this VersionedRemoteProcessGroup. Return type:str

proxy_password

Gets the proxy_password of this VersionedRemoteProcessGroup.

Returns:The proxy_password of this VersionedRemoteProcessGroup. Return type:str

proxy_port

Gets the proxy_port of this VersionedRemoteProcessGroup.

Returns:The proxy_port of this VersionedRemoteProcessGroup. Return type:int

proxy_user

Gets the proxy_user of this VersionedRemoteProcessGroup.

Returns:The proxy_user of this VersionedRemoteProcessGroup. Return type:str

swagger_types = {'comments': 'str', 'communications_timeout': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedRemoteGroupPort]', '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_uri': 'str', 'target_uris': 'str', 'transport_protocol': 'str', 'yield_duration': 'str'}

target_uri

Gets the target_uri of this VersionedRemoteProcessGroup. [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.

Returns:The target_uri of this VersionedRemoteProcessGroup. Return type:str

target_uris

Gets the target_uris of this VersionedRemoteProcessGroup. The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.

Returns:The target_uris of this VersionedRemoteProcessGroup. Return type:str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

transport_protocol

Gets the transport_protocol of this VersionedRemoteProcessGroup. The Transport Protocol that is used for Site-to-Site communications

Returns:The transport_protocol of this VersionedRemoteProcessGroup. Return type:str

yield_duration

Gets the yield_duration of this VersionedRemoteProcessGroup. When yielding, this amount of time must elapse before the remote process group is scheduled again.

Returns:The yield_duration of this VersionedRemoteProcessGroup. Return type:str