Registry Models

Complete model class reference for Registry APIs.

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

Model Type Patterns

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

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

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

Configuration Classes: Settings, parameters, and configuration objects

All Model Classes

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

Bases: object

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

AccessPolicy - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(action=None, configurable=None, identifier=None, resource=None, revision=None, user_groups=None, users=None)

AccessPolicy - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property action

Gets the action of this 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'}

property 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

property 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

property resource

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

Returns:

The resource of this AccessPolicy.

Return type:

str

property revision

Gets the revision of this AccessPolicy.

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

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

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

class nipyapi.registry.models.AccessPolicySummary(action=None, configurable=None, identifier=None, resource=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

__eq__(other)

Returns true if both objects are equal

__init__(action=None, configurable=None, identifier=None, resource=None, revision=None)

AccessPolicySummary - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property action

Gets the action of this 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'}

property 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

property 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

property resource

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

Returns:

The resource of this AccessPolicySummary.

Return type:

str

property revision

Gets the revision of this AccessPolicySummary.

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

class nipyapi.registry.models.AllowableValue(description=None, display_name=None, value=None)

Bases: object

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

AllowableValue - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

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

AllowableValue - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this AllowableValue. The description of the allowable value

Returns:

The description of this AllowableValue.

Return type:

str

property display_name

Gets the display_name of this AllowableValue. The display name of the allowable value

Returns:

The display_name of this AllowableValue.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this AllowableValue. The value of the allowable value

Returns:

The value of this AllowableValue.

Return type:

str

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

Bases: object

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

Attribute - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None)

Attribute - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

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

Returns:

The description of this Attribute.

Return type:

str

property name

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

Returns:

The name of this Attribute.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

BatchSize - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

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

BatchSize - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property count

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

Returns:

The count of this BatchSize.

Return type:

int

property duration

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

Returns:

The duration of this BatchSize.

Return type:

str

property size

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

Returns:

The size of this BatchSize.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.Bucket(allow_bundle_redeploy=None, allow_public_read=None, created_timestamp=None, description=None, identifier=None, link=None, name=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

__eq__(other)

Returns true if both objects are equal

__init__(allow_bundle_redeploy=None, allow_public_read=None, created_timestamp=None, description=None, identifier=None, link=None, name=None, permissions=None, revision=None)

Bucket - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property 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

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

property 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

property description

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

Returns:

The description of this Bucket.

Return type:

str

property identifier

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

Returns:

The identifier of this Bucket.

Return type:

str

property link

Gets the link of this Bucket.

Returns:

The link of this Bucket.

Return type:

Link

property name

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

Returns:

The name of this Bucket.

Return type:

str

property permissions

Gets the permissions of this Bucket.

Returns:

The permissions of this Bucket.

Return type:

Permissions

property revision

Gets the revision of this Bucket.

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': 'Link', 'name': 'str', 'permissions': 'Permissions', 'revision': 'RevisionInfo'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.BucketItem(bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, link=None, modified_timestamp=None, name=None, permissions=None, type=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

__eq__(other)

Returns true if both objects are equal

__init__(bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, link=None, modified_timestamp=None, name=None, permissions=None, type=None)

BucketItem - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property description

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

Returns:

The description of this BucketItem.

Return type:

str

property identifier

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

Returns:

The identifier of this BucketItem.

Return type:

str

property link

Gets the link of this BucketItem.

Returns:

The link of this BucketItem.

Return type:

Link

property 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

property name

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

Returns:

The name of this BucketItem.

Return type:

str

property permissions

Gets the permissions of this BucketItem.

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': 'Link', '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

property type

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

Returns:

The type of this BucketItem.

Return type:

str

class nipyapi.registry.models.BuildInfo(build_branch=None, build_flags=None, build_revision=None, build_tag=None, build_tool=None, built=None, built_by=None)

Bases: object

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

BuildInfo - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(build_branch=None, build_flags=None, build_revision=None, build_tag=None, build_tool=None, built=None, built_by=None)

BuildInfo - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'build_branch': 'buildBranch', 'build_flags': 'buildFlags', 'build_revision': 'buildRevision', 'build_tag': 'buildTag', 'build_tool': 'buildTool', 'built': 'built', 'built_by': 'builtBy'}

property build_branch

Gets the build_branch of this BuildInfo. The branch used to build the version of the bundle

Returns:

The build_branch of this BuildInfo.

Return type:

str

property build_flags

Gets the build_flags of this BuildInfo. The flags used to build the version of the bundle

Returns:

The build_flags of this BuildInfo.

Return type:

str

property build_revision

Gets the build_revision of this BuildInfo. The revision used to build the version of the bundle

Returns:

The build_revision of this BuildInfo.

Return type:

str

property build_tag

Gets the build_tag of this BuildInfo. The tag used to build the version of the bundle

Returns:

The build_tag of this BuildInfo.

Return type:

str

property build_tool

Gets the build_tool of this BuildInfo. The tool used to build the version of the bundle

Returns:

The build_tool of this BuildInfo.

Return type:

str

property built

Gets the built of this BuildInfo. The timestamp the version of the bundle was built

Returns:

The built of this BuildInfo.

Return type:

int

property built_by

Gets the built_by of this BuildInfo. The identity of the user that performed the build

Returns:

The built_by of this BuildInfo.

Return type:

str

swagger_types = {'build_branch': 'str', 'build_flags': 'str', 'build_revision': 'str', 'build_tag': 'str', 'build_tool': 'str', 'built': 'int', 'built_by': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

Bundle - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

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

Bundle - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact

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

Returns:

The artifact of this Bundle.

Return type:

str

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

property group

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

Returns:

The group of this Bundle.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

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

Returns:

The version of this Bundle.

Return type:

str

class nipyapi.registry.models.BundleInfo(artifact_id=None, bucket_id=None, bucket_name=None, bundle_id=None, bundle_type=None, group_id=None, system_api_version=None, version=None)

Bases: object

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

BundleInfo - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, bucket_id=None, bucket_name=None, bundle_id=None, bundle_type=None, group_id=None, system_api_version=None, version=None)

BundleInfo - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this BundleInfo. The artifact id of the bundle

Returns:

The artifact_id of this BundleInfo.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'bucket_id': 'bucketId', 'bucket_name': 'bucketName', 'bundle_id': 'bundleId', 'bundle_type': 'bundleType', 'group_id': 'groupId', 'system_api_version': 'systemApiVersion', 'version': 'version'}

property bucket_id

Gets the bucket_id of this BundleInfo. The id of the bucket where the bundle is located

Returns:

The bucket_id of this BundleInfo.

Return type:

str

property bucket_name

Gets the bucket_name of this BundleInfo. The name of the bucket where the bundle is located

Returns:

The bucket_name of this BundleInfo.

Return type:

str

property bundle_id

Gets the bundle_id of this BundleInfo. The id of the bundle

Returns:

The bundle_id of this BundleInfo.

Return type:

str

property bundle_type

Gets the bundle_type of this BundleInfo. The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)

Returns:

The bundle_type of this BundleInfo.

Return type:

str

property group_id

Gets the group_id of this BundleInfo. The group id of the bundle

Returns:

The group_id of this BundleInfo.

Return type:

str

swagger_types = {'artifact_id': 'str', 'bucket_id': 'str', 'bucket_name': 'str', 'bundle_id': 'str', 'bundle_type': 'str', 'group_id': 'str', 'system_api_version': 'str', 'version': 'str'}

property system_api_version

Gets the system_api_version of this BundleInfo. The version of the system API the bundle was built against

Returns:

The system_api_version of this BundleInfo.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

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

Returns:

The version of this BundleInfo.

Return type:

str

class nipyapi.registry.models.BundleVersion(bucket=None, bundle=None, dependencies=None, filename=None, link=None, version_metadata=None)

Bases: object

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

BundleVersion - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket=None, bundle=None, dependencies=None, filename=None, link=None, version_metadata=None)

BundleVersion - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bucket': 'bucket', 'bundle': 'bundle', 'dependencies': 'dependencies', 'filename': 'filename', 'link': 'link', 'version_metadata': 'versionMetadata'}

property bucket

Gets the bucket of this BundleVersion.

Returns:

The bucket of this BundleVersion.

Return type:

Bucket

property bundle

Gets the bundle of this BundleVersion.

Returns:

The bundle of this BundleVersion.

Return type:

Bundle

property dependencies

Gets the dependencies of this BundleVersion. The set of other bundle versions that this version is dependent on

Returns:

The dependencies of this BundleVersion.

Return type:

list[BundleVersionDependency]

property filename

Gets the filename of this BundleVersion.

Returns:

The filename of this BundleVersion.

Return type:

str

property link

Gets the link of this BundleVersion.

Returns:

The link of this BundleVersion.

Return type:

Link

swagger_types = {'bucket': 'Bucket', 'bundle': 'Bundle', 'dependencies': 'list[BundleVersionDependency]', 'filename': 'str', 'link': 'Link', 'version_metadata': 'BundleVersionMetadata'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version_metadata

Gets the version_metadata of this BundleVersion.

Returns:

The version_metadata of this BundleVersion.

Return type:

BundleVersionMetadata

class nipyapi.registry.models.BundleVersionDependency(artifact_id=None, group_id=None, version=None)

Bases: object

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

BundleVersionDependency - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, group_id=None, version=None)

BundleVersionDependency - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this BundleVersionDependency. The artifact id of the bundle dependency

Returns:

The artifact_id of this BundleVersionDependency.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'group_id': 'groupId', 'version': 'version'}

property group_id

Gets the group_id of this BundleVersionDependency. The group id of the bundle dependency

Returns:

The group_id of this BundleVersionDependency.

Return type:

str

swagger_types = {'artifact_id': 'str', 'group_id': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this BundleVersionDependency. The version of the bundle dependency

Returns:

The version of this BundleVersionDependency.

Return type:

str

class nipyapi.registry.models.BundleVersionMetadata(artifact_id=None, author=None, bucket_id=None, build_info=None, bundle_id=None, content_size=None, description=None, group_id=None, id=None, link=None, sha256=None, sha256_supplied=None, system_api_version=None, timestamp=None, version=None)

Bases: object

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

BundleVersionMetadata - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, author=None, bucket_id=None, build_info=None, bundle_id=None, content_size=None, description=None, group_id=None, id=None, link=None, sha256=None, sha256_supplied=None, system_api_version=None, timestamp=None, version=None)

BundleVersionMetadata - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this BundleVersionMetadata.

Returns:

The artifact_id of this BundleVersionMetadata.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'author': 'author', 'bucket_id': 'bucketId', 'build_info': 'buildInfo', 'bundle_id': 'bundleId', 'content_size': 'contentSize', 'description': 'description', 'group_id': 'groupId', 'id': 'id', 'link': 'link', 'sha256': 'sha256', 'sha256_supplied': 'sha256Supplied', 'system_api_version': 'systemApiVersion', 'timestamp': 'timestamp', 'version': 'version'}

property author

Gets the author of this BundleVersionMetadata. The identity that created this version

Returns:

The author of this BundleVersionMetadata.

Return type:

str

property bucket_id

Gets the bucket_id of this BundleVersionMetadata. The id of the bucket the extension bundle belongs to

Returns:

The bucket_id of this BundleVersionMetadata.

Return type:

str

property build_info

Gets the build_info of this BundleVersionMetadata.

Returns:

The build_info of this BundleVersionMetadata.

Return type:

BuildInfo

property bundle_id

Gets the bundle_id of this BundleVersionMetadata. The id of the extension bundle this version is for

Returns:

The bundle_id of this BundleVersionMetadata.

Return type:

str

property content_size

Gets the content_size of this BundleVersionMetadata. The size of the binary content for this version in bytes

Returns:

The content_size of this BundleVersionMetadata.

Return type:

int

property description

Gets the description of this BundleVersionMetadata. The description for this version

Returns:

The description of this BundleVersionMetadata.

Return type:

str

property group_id

Gets the group_id of this BundleVersionMetadata.

Returns:

The group_id of this BundleVersionMetadata.

Return type:

str

property id

Gets the id of this BundleVersionMetadata. The id of this version of the extension bundle

Returns:

The id of this BundleVersionMetadata.

Return type:

str

property link

Gets the link of this BundleVersionMetadata.

Returns:

The link of this BundleVersionMetadata.

Return type:

Link

property sha256

Gets the sha256 of this BundleVersionMetadata. The hex representation of the SHA-256 digest of the binary content for this version

Returns:

The sha256 of this BundleVersionMetadata.

Return type:

str

property sha256_supplied

Gets the sha256_supplied of this BundleVersionMetadata. Whether or not the client supplied a SHA-256 when uploading the bundle

Returns:

The sha256_supplied of this BundleVersionMetadata.

Return type:

bool

swagger_types = {'artifact_id': 'str', 'author': 'str', 'bucket_id': 'str', 'build_info': 'BuildInfo', 'bundle_id': 'str', 'content_size': 'int', 'description': 'str', 'group_id': 'str', 'id': 'str', 'link': 'Link', 'sha256': 'str', 'sha256_supplied': 'bool', 'system_api_version': 'str', 'timestamp': 'int', 'version': 'str'}

property system_api_version

Gets the system_api_version of this BundleVersionMetadata. The version of the system API that this bundle version was built against

Returns:

The system_api_version of this BundleVersionMetadata.

Return type:

str

property timestamp

Gets the timestamp of this BundleVersionMetadata. The timestamp of the create date of this version

Returns:

The timestamp of this BundleVersionMetadata.

Return type:

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this BundleVersionMetadata. The version of the extension bundle

Returns:

The version of this BundleVersionMetadata.

Return type:

str

class nipyapi.registry.models.BundlesBundleTypeBody(file=None, sha256=None)

Bases: object

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

BundlesBundleTypeBody - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(file=None, sha256=None)

BundlesBundleTypeBody - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'file': 'file', 'sha256': 'sha256'}

property file

Gets the file of this BundlesBundleTypeBody.

Returns:

The file of this BundlesBundleTypeBody.

Return type:

FormDataContentDisposition

property sha256

Gets the sha256 of this BundlesBundleTypeBody.

Returns:

The sha256 of this BundlesBundleTypeBody.

Return type:

str

swagger_types = {'file': 'FormDataContentDisposition', 'sha256': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ClientIdParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(client_id=None)

ClientIdParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'client_id': 'clientId'}

property client_id

Gets the client_id of this ClientIdParameter.

Returns:

The client_id of this ClientIdParameter.

Return type:

str

swagger_types = {'client_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ComponentDifference(change_description=None, difference_type=None, difference_type_description=None, value_a=None, value_b=None)

Bases: object

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

ComponentDifference - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(change_description=None, difference_type=None, difference_type_description=None, value_a=None, value_b=None)

ComponentDifference - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'change_description': 'changeDescription', 'difference_type': 'differenceType', 'difference_type_description': 'differenceTypeDescription', 'value_a': 'valueA', 'value_b': 'valueB'}

property change_description

Gets the change_description of this ComponentDifference. The description of the change.

Returns:

The change_description of this ComponentDifference.

Return type:

str

property difference_type

Gets the difference_type of this ComponentDifference. The key to the difference.

Returns:

The difference_type of this ComponentDifference.

Return type:

str

property difference_type_description

Gets the difference_type_description of this ComponentDifference. The description of the change type.

Returns:

The difference_type_description of this ComponentDifference.

Return type:

str

swagger_types = {'change_description': 'str', 'difference_type': 'str', 'difference_type_description': 'str', 'value_a': 'str', 'value_b': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value_a

Gets the value_a of this ComponentDifference. The earlier value from the difference.

Returns:

The value_a of this ComponentDifference.

Return type:

str

property value_b

Gets the value_b of this ComponentDifference. The newer value from the difference.

Returns:

The value_b of this ComponentDifference.

Return type:

str

class nipyapi.registry.models.ComponentDifferenceGroup(component_id=None, component_name=None, component_type=None, differences=None, process_group_id=None)

Bases: object

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

ComponentDifferenceGroup - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

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

ComponentDifferenceGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property component_id

Gets the component_id of this ComponentDifferenceGroup. The id of the component whose changes are grouped together.

Returns:

The component_id of this ComponentDifferenceGroup.

Return type:

str

property component_name

Gets the component_name of this ComponentDifferenceGroup. The name of the component whose changes are grouped together.

Returns:

The component_name of this ComponentDifferenceGroup.

Return type:

str

property component_type

Gets the component_type of this ComponentDifferenceGroup. The type of component these changes relate to.

Returns:

The component_type of this ComponentDifferenceGroup.

Return type:

str

property differences

Gets the differences of this ComponentDifferenceGroup. The list of changes related to this component between the 2 versions.

Returns:

The differences of this ComponentDifferenceGroup.

Return type:

list[ComponentDifference]

property process_group_id

Gets the process_group_id of this ComponentDifferenceGroup. The process group id for this component.

Returns:

The process_group_id of this ComponentDifferenceGroup.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

ConnectableComponent - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

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

ConnectableComponent - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property comments

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

Returns:

The comments of this ConnectableComponent.

Return type:

str

property group_id

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

Returns:

The group_id of this ConnectableComponent.

Return type:

str

property id

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

Returns:

The id of this ConnectableComponent.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this ConnectableComponent.

Return type:

str

property name

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

Returns:

The name of this ConnectableComponent.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this ConnectableComponent.

Return type:

str

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

Bases: object

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

ControllerServiceAPI - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, type=None)

ControllerServiceAPI - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bundle

Gets the bundle of this ControllerServiceAPI.

Returns:

The bundle of this ControllerServiceAPI.

Return type:

Bundle

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this ControllerServiceAPI.

Return type:

str

class nipyapi.registry.models.ControllerServiceDefinition(artifact_id=None, class_name=None, group_id=None, version=None)

Bases: object

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

ControllerServiceDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, class_name=None, group_id=None, version=None)

ControllerServiceDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this ControllerServiceDefinition. The artifact id of the service API

Returns:

The artifact_id of this ControllerServiceDefinition.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'class_name': 'className', 'group_id': 'groupId', 'version': 'version'}

property class_name

Gets the class_name of this ControllerServiceDefinition. The class name of the service API

Returns:

The class_name of this ControllerServiceDefinition.

Return type:

str

property group_id

Gets the group_id of this ControllerServiceDefinition. The group id of the service API

Returns:

The group_id of this ControllerServiceDefinition.

Return type:

str

swagger_types = {'artifact_id': 'str', 'class_name': 'str', 'group_id': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this ControllerServiceDefinition. The version of the service API

Returns:

The version of this ControllerServiceDefinition.

Return type:

str

class nipyapi.registry.models.CurrentUser(anonymous=None, identity=None, login_supported=None, oidclogin_supported=None, resource_permissions=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

__eq__(other)

Returns true if both objects are equal

__init__(anonymous=None, identity=None, login_supported=None, oidclogin_supported=None, resource_permissions=None)

CurrentUser - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property anonymous

Gets the anonymous of this 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'}

property identity

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

Returns:

The identity of this CurrentUser.

Return type:

str

property 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

property 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

property resource_permissions

Gets the resource_permissions of this CurrentUser.

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

class nipyapi.registry.models.DefaultSchedule(concurrent_tasks=None, period=None, strategy=None)

Bases: object

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

DefaultSchedule - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(concurrent_tasks=None, period=None, strategy=None)

DefaultSchedule - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'concurrent_tasks': 'concurrentTasks', 'period': 'period', 'strategy': 'strategy'}

property concurrent_tasks

Gets the concurrent_tasks of this DefaultSchedule. The default concurrent tasks

Returns:

The concurrent_tasks of this DefaultSchedule.

Return type:

str

property period

Gets the period of this DefaultSchedule. The default scheduling period

Returns:

The period of this DefaultSchedule.

Return type:

str

property strategy

Gets the strategy of this DefaultSchedule. The default scheduling strategy

Returns:

The strategy of this DefaultSchedule.

Return type:

str

swagger_types = {'concurrent_tasks': 'str', 'period': 'str', 'strategy': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.DefaultSettings(bulletin_level=None, penalty_duration=None, yield_duration=None)

Bases: object

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

DefaultSettings - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bulletin_level=None, penalty_duration=None, yield_duration=None)

DefaultSettings - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bulletin_level': 'bulletinLevel', 'penalty_duration': 'penaltyDuration', 'yield_duration': 'yieldDuration'}

property bulletin_level

Gets the bulletin_level of this DefaultSettings. The default bulletin level

Returns:

The bulletin_level of this DefaultSettings.

Return type:

str

property penalty_duration

Gets the penalty_duration of this DefaultSettings. The default penalty duration

Returns:

The penalty_duration of this DefaultSettings.

Return type:

str

swagger_types = {'bulletin_level': 'str', 'penalty_duration': 'str', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property yield_duration

Gets the yield_duration of this DefaultSettings. The default yield duration

Returns:

The yield_duration of this DefaultSettings.

Return type:

str

class nipyapi.registry.models.Dependency(dependent_values=None, property_display_name=None, property_name=None)

Bases: object

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

Dependency - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(dependent_values=None, property_display_name=None, property_name=None)

Dependency - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'dependent_values': 'dependentValues', 'property_display_name': 'propertyDisplayName', 'property_name': 'propertyName'}

property dependent_values

Gets the dependent_values of this Dependency.

Returns:

The dependent_values of this Dependency.

Return type:

DependentValues

property property_display_name

Gets the property_display_name of this Dependency. The display name of the dependent property

Returns:

The property_display_name of this Dependency.

Return type:

str

property property_name

Gets the property_name of this Dependency. The name of the dependent property

Returns:

The property_name of this Dependency.

Return type:

str

swagger_types = {'dependent_values': 'DependentValues', 'property_display_name': 'str', 'property_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.DependentValues(values=None)

Bases: object

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

DependentValues - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(values=None)

DependentValues - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'values': 'values'}

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property values

Gets the values of this DependentValues. The dependent values

Returns:

The values of this DependentValues.

Return type:

list[str]

class nipyapi.registry.models.DeprecationNotice(alternatives=None, reason=None)

Bases: object

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

DeprecationNotice - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(alternatives=None, reason=None)

DeprecationNotice - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property alternatives

Gets the alternatives of this DeprecationNotice. The alternatives to use

Returns:

The alternatives of this DeprecationNotice.

Return type:

list[str]

attribute_map = {'alternatives': 'alternatives', 'reason': 'reason'}

property reason

Gets the reason of this DeprecationNotice. The reason for the deprecation

Returns:

The reason of this DeprecationNotice.

Return type:

str

swagger_types = {'alternatives': 'list[str]', 'reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

DynamicProperty - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

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

DynamicProperty - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

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

Returns:

The description of this DynamicProperty.

Return type:

str

property expression_language_scope

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

Returns:

The expression_language_scope of this DynamicProperty.

Return type:

str

property expression_language_supported

Gets the expression_language_supported of this DynamicProperty. Whether or not expression language is supported

Returns:

The expression_language_supported of this DynamicProperty.

Return type:

bool

property name

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

Returns:

The name of this DynamicProperty.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

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

Returns:

The value of this DynamicProperty.

Return type:

str

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

Bases: object

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

DynamicRelationship - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None)

DynamicRelationship - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

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

Returns:

The description of this DynamicRelationship.

Return type:

str

property name

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

Returns:

The name of this DynamicRelationship.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.Extension(default_schedule=None, default_settings=None, deprecation_notice=None, description=None, dynamic_properties=None, dynamic_relationship=None, input_requirement=None, multi_processor_use_cases=None, name=None, primary_node_only=None, properties=None, provided_service_apis=None, reads_attributes=None, relationships=None, restricted=None, see_also=None, side_effect_free=None, stateful=None, supports_batching=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, trigger_serially=None, trigger_when_any_destination_available=None, trigger_when_empty=None, type=None, use_cases=None, writes_attributes=None)

Bases: object

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

Extension - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(default_schedule=None, default_settings=None, deprecation_notice=None, description=None, dynamic_properties=None, dynamic_relationship=None, input_requirement=None, multi_processor_use_cases=None, name=None, primary_node_only=None, properties=None, provided_service_apis=None, reads_attributes=None, relationships=None, restricted=None, see_also=None, side_effect_free=None, stateful=None, supports_batching=None, supports_sensitive_dynamic_properties=None, system_resource_considerations=None, tags=None, trigger_serially=None, trigger_when_any_destination_available=None, trigger_when_empty=None, type=None, use_cases=None, writes_attributes=None)

Extension - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'default_schedule': 'defaultSchedule', 'default_settings': 'defaultSettings', 'deprecation_notice': 'deprecationNotice', 'description': 'description', 'dynamic_properties': 'dynamicProperties', 'dynamic_relationship': 'dynamicRelationship', 'input_requirement': 'inputRequirement', 'multi_processor_use_cases': 'multiProcessorUseCases', 'name': 'name', 'primary_node_only': 'primaryNodeOnly', 'properties': 'properties', 'provided_service_apis': 'providedServiceAPIs', 'reads_attributes': 'readsAttributes', 'relationships': 'relationships', 'restricted': 'restricted', 'see_also': 'seeAlso', 'side_effect_free': 'sideEffectFree', 'stateful': 'stateful', 'supports_batching': 'supportsBatching', 'supports_sensitive_dynamic_properties': 'supportsSensitiveDynamicProperties', 'system_resource_considerations': 'systemResourceConsiderations', 'tags': 'tags', 'trigger_serially': 'triggerSerially', 'trigger_when_any_destination_available': 'triggerWhenAnyDestinationAvailable', 'trigger_when_empty': 'triggerWhenEmpty', 'type': 'type', 'use_cases': 'useCases', 'writes_attributes': 'writesAttributes'}

property default_schedule

Gets the default_schedule of this Extension.

Returns:

The default_schedule of this Extension.

Return type:

DefaultSchedule

property default_settings

Gets the default_settings of this Extension.

Returns:

The default_settings of this Extension.

Return type:

DefaultSettings

property deprecation_notice

Gets the deprecation_notice of this Extension.

Returns:

The deprecation_notice of this Extension.

Return type:

DeprecationNotice

property description

Gets the description of this Extension. The description of the extension

Returns:

The description of this Extension.

Return type:

str

property dynamic_properties

Gets the dynamic_properties of this Extension. The dynamic properties of the extension

Returns:

The dynamic_properties of this Extension.

Return type:

list[DynamicProperty]

property dynamic_relationship

Gets the dynamic_relationship of this Extension.

Returns:

The dynamic_relationship of this Extension.

Return type:

DynamicRelationship

property input_requirement

Gets the input_requirement of this Extension. The input requirement of the extension

Returns:

The input_requirement of this Extension.

Return type:

str

property multi_processor_use_cases

Gets the multi_processor_use_cases of this Extension. Zero or more documented use cases for how the processor may be used in conjunction with other processors

Returns:

The multi_processor_use_cases of this Extension.

Return type:

list[MultiProcessorUseCase]

property name

Gets the name of this Extension. The name of the extension

Returns:

The name of this Extension.

Return type:

str

property primary_node_only

Gets the primary_node_only of this Extension. Indicates that a processor should be scheduled only on the primary node

Returns:

The primary_node_only of this Extension.

Return type:

bool

property properties

Gets the properties of this Extension. The properties of the extension

Returns:

The properties of this Extension.

Return type:

list[ModelProperty]

property provided_service_apis

Gets the provided_service_apis of this Extension. The service APIs provided by this extension

Returns:

The provided_service_apis of this Extension.

Return type:

list[ProvidedServiceAPI]

property reads_attributes

Gets the reads_attributes of this Extension. The attributes read from flow files by the extension

Returns:

The reads_attributes of this Extension.

Return type:

list[Attribute]

property relationships

Gets the relationships of this Extension. The relationships of the extension

Returns:

The relationships of this Extension.

Return type:

list[Relationship]

property restricted

Gets the restricted of this Extension.

Returns:

The restricted of this Extension.

Return type:

Restricted

property see_also

Gets the see_also of this Extension. The names of other extensions to see

Returns:

The see_also of this Extension.

Return type:

list[str]

property side_effect_free

Gets the side_effect_free of this Extension. Indicates that a processor is side effect free

Returns:

The side_effect_free of this Extension.

Return type:

bool

property stateful

Gets the stateful of this Extension.

Returns:

The stateful of this Extension.

Return type:

Stateful

property supports_batching

Gets the supports_batching of this Extension. Indicates that a processor supports batching

Returns:

The supports_batching of this Extension.

Return type:

bool

property supports_sensitive_dynamic_properties

Gets the supports_sensitive_dynamic_properties of this Extension.

Returns:

The supports_sensitive_dynamic_properties of this Extension.

Return type:

bool

swagger_types = {'default_schedule': 'DefaultSchedule', 'default_settings': 'DefaultSettings', 'deprecation_notice': 'DeprecationNotice', 'description': 'str', 'dynamic_properties': 'list[DynamicProperty]', 'dynamic_relationship': 'DynamicRelationship', 'input_requirement': 'str', 'multi_processor_use_cases': 'list[MultiProcessorUseCase]', 'name': 'str', 'primary_node_only': 'bool', 'properties': 'list[ModelProperty]', 'provided_service_apis': 'list[ProvidedServiceAPI]', 'reads_attributes': 'list[Attribute]', 'relationships': 'list[Relationship]', 'restricted': 'Restricted', 'see_also': 'list[str]', 'side_effect_free': 'bool', 'stateful': 'Stateful', 'supports_batching': 'bool', 'supports_sensitive_dynamic_properties': 'bool', 'system_resource_considerations': 'list[SystemResourceConsideration]', 'tags': 'list[str]', 'trigger_serially': 'bool', 'trigger_when_any_destination_available': 'bool', 'trigger_when_empty': 'bool', 'type': 'str', 'use_cases': 'list[UseCase]', 'writes_attributes': 'list[Attribute]'}

property system_resource_considerations

Gets the system_resource_considerations of this Extension. The resource considerations of the extension

Returns:

The system_resource_considerations of this Extension.

Return type:

list[SystemResourceConsideration]

property tags

Gets the tags of this Extension. The tags of the extension

Returns:

The tags of this Extension.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property trigger_serially

Gets the trigger_serially of this Extension. Indicates that a processor should be triggered serially

Returns:

The trigger_serially of this Extension.

Return type:

bool

property trigger_when_any_destination_available

Gets the trigger_when_any_destination_available of this Extension. Indicates that a processor should be triggered when any destinations have space for flow files

Returns:

The trigger_when_any_destination_available of this Extension.

Return type:

bool

property trigger_when_empty

Gets the trigger_when_empty of this Extension. Indicates that a processor should be triggered when the incoming queues are empty

Returns:

The trigger_when_empty of this Extension.

Return type:

bool

property type

Gets the type of this Extension. The type of the extension

Returns:

The type of this Extension.

Return type:

str

property use_cases

Gets the use_cases of this Extension. Zero or more documented use cases for how the extension may be used

Returns:

The use_cases of this Extension.

Return type:

list[UseCase]

property writes_attributes

Gets the writes_attributes of this Extension. The attributes written to flow files by the extension

Returns:

The writes_attributes of this Extension.

Return type:

list[Attribute]

class nipyapi.registry.models.ExtensionFilterParams(bundle_type=None, extension_type=None, tags=None)

Bases: object

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

ExtensionFilterParams - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle_type=None, extension_type=None, tags=None)

ExtensionFilterParams - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bundle_type': 'bundleType', 'extension_type': 'extensionType', 'tags': 'tags'}

property bundle_type

Gets the bundle_type of this ExtensionFilterParams. The type of bundle

Returns:

The bundle_type of this ExtensionFilterParams.

Return type:

str

property extension_type

Gets the extension_type of this ExtensionFilterParams. The type of extension

Returns:

The extension_type of this ExtensionFilterParams.

Return type:

str

swagger_types = {'bundle_type': 'str', 'extension_type': 'str', 'tags': 'list[str]'}

property tags

Gets the tags of this ExtensionFilterParams. The tags

Returns:

The tags of this ExtensionFilterParams.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ExtensionMetadata(bundle_info=None, deprecation_notice=None, description=None, display_name=None, has_additional_details=None, link=None, link_docs=None, name=None, provided_service_apis=None, restricted=None, tags=None, type=None)

Bases: object

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

ExtensionMetadata - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle_info=None, deprecation_notice=None, description=None, display_name=None, has_additional_details=None, link=None, link_docs=None, name=None, provided_service_apis=None, restricted=None, tags=None, type=None)

ExtensionMetadata - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bundle_info': 'bundleInfo', 'deprecation_notice': 'deprecationNotice', 'description': 'description', 'display_name': 'displayName', 'has_additional_details': 'hasAdditionalDetails', 'link': 'link', 'link_docs': 'linkDocs', 'name': 'name', 'provided_service_apis': 'providedServiceAPIs', 'restricted': 'restricted', 'tags': 'tags', 'type': 'type'}

property bundle_info

Gets the bundle_info of this ExtensionMetadata.

Returns:

The bundle_info of this ExtensionMetadata.

Return type:

BundleInfo

property deprecation_notice

Gets the deprecation_notice of this ExtensionMetadata.

Returns:

The deprecation_notice of this ExtensionMetadata.

Return type:

DeprecationNotice

property description

Gets the description of this ExtensionMetadata. The description of the extension

Returns:

The description of this ExtensionMetadata.

Return type:

str

property display_name

Gets the display_name of this ExtensionMetadata. The display name of the extension

Returns:

The display_name of this ExtensionMetadata.

Return type:

str

property has_additional_details

Gets the has_additional_details of this ExtensionMetadata. Whether or not the extension has additional detail documentation

Returns:

The has_additional_details of this ExtensionMetadata.

Return type:

bool

property link

Gets the link of this ExtensionMetadata.

Returns:

The link of this ExtensionMetadata.

Return type:

Link

property link_docs

Gets the link_docs of this ExtensionMetadata.

Returns:

The link_docs of this ExtensionMetadata.

Return type:

Link

property name

Gets the name of this ExtensionMetadata. The name of the extension

Returns:

The name of this ExtensionMetadata.

Return type:

str

property provided_service_apis

Gets the provided_service_apis of this ExtensionMetadata. The service APIs provided by the extension

Returns:

The provided_service_apis of this ExtensionMetadata.

Return type:

list[ProvidedServiceAPI]

property restricted

Gets the restricted of this ExtensionMetadata.

Returns:

The restricted of this ExtensionMetadata.

Return type:

Restricted

swagger_types = {'bundle_info': 'BundleInfo', 'deprecation_notice': 'DeprecationNotice', 'description': 'str', 'display_name': 'str', 'has_additional_details': 'bool', 'link': 'Link', 'link_docs': 'Link', 'name': 'str', 'provided_service_apis': 'list[ProvidedServiceAPI]', 'restricted': 'Restricted', 'tags': 'list[str]', 'type': 'str'}

property tags

Gets the tags of this ExtensionMetadata. The tags of the extension

Returns:

The tags of this ExtensionMetadata.

Return type:

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ExtensionMetadata. The type of the extension

Returns:

The type of this ExtensionMetadata.

Return type:

str

class nipyapi.registry.models.ExtensionMetadataContainer(extensions=None, filter_params=None, num_results=None)

Bases: object

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

ExtensionMetadataContainer - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(extensions=None, filter_params=None, num_results=None)

ExtensionMetadataContainer - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'extensions': 'extensions', 'filter_params': 'filterParams', 'num_results': 'numResults'}

property extensions

Gets the extensions of this ExtensionMetadataContainer. The metadata for the extensions

Returns:

The extensions of this ExtensionMetadataContainer.

Return type:

list[ExtensionMetadata]

property filter_params

Gets the filter_params of this ExtensionMetadataContainer.

Returns:

The filter_params of this ExtensionMetadataContainer.

Return type:

ExtensionFilterParams

property num_results

Gets the num_results of this ExtensionMetadataContainer. The number of extensions in the response

Returns:

The num_results of this ExtensionMetadataContainer.

Return type:

int

swagger_types = {'extensions': 'list[ExtensionMetadata]', 'filter_params': 'ExtensionFilterParams', 'num_results': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ExtensionRepoArtifact(artifact_id=None, bucket_name=None, group_id=None, link=None)

Bases: object

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

ExtensionRepoArtifact - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, bucket_name=None, group_id=None, link=None)

ExtensionRepoArtifact - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this ExtensionRepoArtifact. The artifact id

Returns:

The artifact_id of this ExtensionRepoArtifact.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'bucket_name': 'bucketName', 'group_id': 'groupId', 'link': 'link'}

property bucket_name

Gets the bucket_name of this ExtensionRepoArtifact. The bucket name

Returns:

The bucket_name of this ExtensionRepoArtifact.

Return type:

str

property group_id

Gets the group_id of this ExtensionRepoArtifact. The group id

Returns:

The group_id of this ExtensionRepoArtifact.

Return type:

str

property link

Gets the link of this ExtensionRepoArtifact.

Returns:

The link of this ExtensionRepoArtifact.

Return type:

Link

swagger_types = {'artifact_id': 'str', 'bucket_name': 'str', 'group_id': 'str', 'link': 'Link'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ExtensionRepoBucket(bucket_name=None, link=None)

Bases: object

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

ExtensionRepoBucket - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket_name=None, link=None)

ExtensionRepoBucket - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bucket_name': 'bucketName', 'link': 'link'}

property bucket_name

Gets the bucket_name of this ExtensionRepoBucket. The name of the bucket

Returns:

The bucket_name of this ExtensionRepoBucket.

Return type:

str

property link

Gets the link of this ExtensionRepoBucket.

Returns:

The link of this ExtensionRepoBucket.

Return type:

Link

swagger_types = {'bucket_name': 'str', 'link': 'Link'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ExtensionRepoGroup(bucket_name=None, group_id=None, link=None)

Bases: object

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

ExtensionRepoGroup - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket_name=None, group_id=None, link=None)

ExtensionRepoGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bucket_name': 'bucketName', 'group_id': 'groupId', 'link': 'link'}

property bucket_name

Gets the bucket_name of this ExtensionRepoGroup. The bucket name

Returns:

The bucket_name of this ExtensionRepoGroup.

Return type:

str

property group_id

Gets the group_id of this ExtensionRepoGroup. The group id

Returns:

The group_id of this ExtensionRepoGroup.

Return type:

str

property link

Gets the link of this ExtensionRepoGroup.

Returns:

The link of this ExtensionRepoGroup.

Return type:

Link

swagger_types = {'bucket_name': 'str', 'group_id': 'str', 'link': 'Link'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ExtensionRepoVersion(download_link=None, extensions_link=None, sha256_link=None, sha256_supplied=None)

Bases: object

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

ExtensionRepoVersion - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(download_link=None, extensions_link=None, sha256_link=None, sha256_supplied=None)

ExtensionRepoVersion - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'download_link': 'downloadLink', 'extensions_link': 'extensionsLink', 'sha256_link': 'sha256Link', 'sha256_supplied': 'sha256Supplied'}

property download_link

Gets the download_link of this ExtensionRepoVersion.

Returns:

The download_link of this ExtensionRepoVersion.

Return type:

Link

property extensions_link

Gets the extensions_link of this ExtensionRepoVersion.

Returns:

The extensions_link of this ExtensionRepoVersion.

Return type:

Link

property sha256_link

Gets the sha256_link of this ExtensionRepoVersion.

Returns:

The sha256_link of this ExtensionRepoVersion.

Return type:

Link

property sha256_supplied

Gets the sha256_supplied of this ExtensionRepoVersion. Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.

Returns:

The sha256_supplied of this ExtensionRepoVersion.

Return type:

bool

swagger_types = {'download_link': 'Link', 'extensions_link': 'Link', 'sha256_link': 'Link', 'sha256_supplied': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ExtensionRepoVersionSummary(artifact_id=None, author=None, bucket_name=None, group_id=None, link=None, timestamp=None, version=None)

Bases: object

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

ExtensionRepoVersionSummary - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, author=None, bucket_name=None, group_id=None, link=None, timestamp=None, version=None)

ExtensionRepoVersionSummary - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this ExtensionRepoVersionSummary. The artifact id

Returns:

The artifact_id of this ExtensionRepoVersionSummary.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'author': 'author', 'bucket_name': 'bucketName', 'group_id': 'groupId', 'link': 'link', 'timestamp': 'timestamp', 'version': 'version'}

property author

Gets the author of this ExtensionRepoVersionSummary. The identity of the user that created this version

Returns:

The author of this ExtensionRepoVersionSummary.

Return type:

str

property bucket_name

Gets the bucket_name of this ExtensionRepoVersionSummary. The bucket name

Returns:

The bucket_name of this ExtensionRepoVersionSummary.

Return type:

str

property group_id

Gets the group_id of this ExtensionRepoVersionSummary. The group id

Returns:

The group_id of this ExtensionRepoVersionSummary.

Return type:

str

property link

Gets the link of this ExtensionRepoVersionSummary.

Returns:

The link of this ExtensionRepoVersionSummary.

Return type:

Link

swagger_types = {'artifact_id': 'str', 'author': 'str', 'bucket_name': 'str', 'group_id': 'str', 'link': 'Link', 'timestamp': 'int', 'version': 'str'}

property timestamp

Gets the timestamp of this ExtensionRepoVersionSummary. The timestamp of when this version was created

Returns:

The timestamp of this ExtensionRepoVersionSummary.

Return type:

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this ExtensionRepoVersionSummary. The version

Returns:

The version of this ExtensionRepoVersionSummary.

Return type:

str

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

Bases: object

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

ExternalControllerServiceReference - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(identifier=None, name=None)

ExternalControllerServiceReference - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property identifier

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

Returns:

The identifier of this ExternalControllerServiceReference.

Return type:

str

property name

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

Returns:

The name of this ExternalControllerServiceReference.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.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

__eq__(other)

Returns true if both objects are equal

__init__(fields=None)

Fields - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'fields': 'fields'}

property 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

class nipyapi.registry.models.FormDataContentDisposition(creation_date=None, file_name=None, modification_date=None, name=None, parameters=None, read_date=None, size=None, type=None)

Bases: object

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

FormDataContentDisposition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(creation_date=None, file_name=None, modification_date=None, name=None, parameters=None, read_date=None, size=None, type=None)

FormDataContentDisposition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'creation_date': 'creationDate', 'file_name': 'fileName', 'modification_date': 'modificationDate', 'name': 'name', 'parameters': 'parameters', 'read_date': 'readDate', 'size': 'size', 'type': 'type'}

property creation_date

Gets the creation_date of this FormDataContentDisposition.

Returns:

The creation_date of this FormDataContentDisposition.

Return type:

datetime

property file_name

Gets the file_name of this FormDataContentDisposition.

Returns:

The file_name of this FormDataContentDisposition.

Return type:

str

property modification_date

Gets the modification_date of this FormDataContentDisposition.

Returns:

The modification_date of this FormDataContentDisposition.

Return type:

datetime

property name

Gets the name of this FormDataContentDisposition.

Returns:

The name of this FormDataContentDisposition.

Return type:

str

property parameters

Gets the parameters of this FormDataContentDisposition.

Returns:

The parameters of this FormDataContentDisposition.

Return type:

dict(str, str)

property read_date

Gets the read_date of this FormDataContentDisposition.

Returns:

The read_date of this FormDataContentDisposition.

Return type:

datetime

property size

Gets the size of this FormDataContentDisposition.

Returns:

The size of this FormDataContentDisposition.

Return type:

int

swagger_types = {'creation_date': 'datetime', 'file_name': 'str', 'modification_date': 'datetime', 'name': 'str', 'parameters': 'dict(str, str)', 'read_date': 'datetime', 'size': 'int', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this FormDataContentDisposition.

Returns:

The type of this FormDataContentDisposition.

Return type:

str

class nipyapi.registry.models.Link(params=None, rel=None, rels=None, title=None, type=None, uri=None, uri_builder=None)

Bases: object

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

Link - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(params=None, rel=None, rels=None, title=None, type=None, uri=None, uri_builder=None)

Link - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'params': 'params', 'rel': 'rel', 'rels': 'rels', 'title': 'title', 'type': 'type', 'uri': 'uri', 'uri_builder': 'uriBuilder'}

property params

Gets the params of this Link.

Returns:

The params of this Link.

Return type:

dict(str, str)

property rel

Gets the rel of this Link.

Returns:

The rel of this Link.

Return type:

str

property rels

Gets the rels of this Link.

Returns:

The rels of this Link.

Return type:

list[str]

swagger_types = {'params': 'dict(str, str)', 'rel': 'str', 'rels': 'list[str]', 'title': 'str', 'type': 'str', 'uri': 'str', 'uri_builder': 'UriBuilder'}

property title

Gets the title of this Link.

Returns:

The title of this Link.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this Link.

Returns:

The type of this Link.

Return type:

str

property uri

Gets the uri of this Link.

Returns:

The uri of this Link.

Return type:

str

property uri_builder

Gets the uri_builder of this Link.

Returns:

The uri_builder of this Link.

Return type:

UriBuilder

class nipyapi.registry.models.LongParameter(long=None)

Bases: object

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

LongParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(long=None)

LongParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'long': 'long'}

property long

Gets the long of this LongParameter.

Returns:

The long of this LongParameter.

Return type:

int

swagger_types = {'long': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ModelProperty(allowable_values=None, controller_service_definition=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, dynamically_modifies_classpath=None, expression_language_scope=None, expression_language_supported=None, name=None, required=None, resource_definition=None, sensitive=None)

Bases: object

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

ModelProperty - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(allowable_values=None, controller_service_definition=None, default_value=None, dependencies=None, description=None, display_name=None, dynamic=None, dynamically_modifies_classpath=None, expression_language_scope=None, expression_language_supported=None, name=None, required=None, resource_definition=None, sensitive=None)

ModelProperty - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property allowable_values

Gets the allowable_values of this ModelProperty. The allowable values for this property

Returns:

The allowable_values of this ModelProperty.

Return type:

list[AllowableValue]

attribute_map = {'allowable_values': 'allowableValues', 'controller_service_definition': 'controllerServiceDefinition', 'default_value': 'defaultValue', 'dependencies': 'dependencies', 'description': 'description', 'display_name': 'displayName', 'dynamic': 'dynamic', 'dynamically_modifies_classpath': 'dynamicallyModifiesClasspath', 'expression_language_scope': 'expressionLanguageScope', 'expression_language_supported': 'expressionLanguageSupported', 'name': 'name', 'required': 'required', 'resource_definition': 'resourceDefinition', 'sensitive': 'sensitive'}

property controller_service_definition

Gets the controller_service_definition of this ModelProperty.

Returns:

The controller_service_definition of this ModelProperty.

Return type:

ControllerServiceDefinition

property default_value

Gets the default_value of this ModelProperty. The default value

Returns:

The default_value of this ModelProperty.

Return type:

str

property dependencies

Gets the dependencies of this ModelProperty. The properties that this property depends on

Returns:

The dependencies of this ModelProperty.

Return type:

list[Dependency]

property description

Gets the description of this ModelProperty. The description

Returns:

The description of this ModelProperty.

Return type:

str

property display_name

Gets the display_name of this ModelProperty. The display name

Returns:

The display_name of this ModelProperty.

Return type:

str

property dynamic

Gets the dynamic of this ModelProperty. Whether or not the processor is dynamic

Returns:

The dynamic of this ModelProperty.

Return type:

bool

property dynamically_modifies_classpath

Gets the dynamically_modifies_classpath of this ModelProperty. Whether or not the processor dynamically modifies the classpath

Returns:

The dynamically_modifies_classpath of this ModelProperty.

Return type:

bool

property expression_language_scope

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

Returns:

The expression_language_scope of this ModelProperty.

Return type:

str

property expression_language_supported

Gets the expression_language_supported of this ModelProperty. Whether or not expression language is supported

Returns:

The expression_language_supported of this ModelProperty.

Return type:

bool

property name

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

Returns:

The name of this ModelProperty.

Return type:

str

property required

Gets the required of this ModelProperty. Whether or not the property is required

Returns:

The required of this ModelProperty.

Return type:

bool

property resource_definition

Gets the resource_definition of this ModelProperty.

Returns:

The resource_definition of this ModelProperty.

Return type:

ResourceDefinition

property sensitive

Gets the sensitive of this ModelProperty. Whether or not the property is sensitive

Returns:

The sensitive of this ModelProperty.

Return type:

bool

swagger_types = {'allowable_values': 'list[AllowableValue]', 'controller_service_definition': 'ControllerServiceDefinition', 'default_value': 'str', 'dependencies': 'list[Dependency]', 'description': 'str', 'display_name': 'str', 'dynamic': 'bool', 'dynamically_modifies_classpath': 'bool', 'expression_language_scope': 'str', 'expression_language_supported': 'bool', 'name': 'str', 'required': 'bool', 'resource_definition': 'ResourceDefinition', 'sensitive': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.MultiProcessorUseCase(description=None, keywords=None, notes=None, processor_configurations=None)

Bases: object

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

MultiProcessorUseCase - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, keywords=None, notes=None, processor_configurations=None)

MultiProcessorUseCase - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'keywords': 'keywords', 'notes': 'notes', 'processor_configurations': 'processorConfigurations'}

property description

Gets the description of this MultiProcessorUseCase.

Returns:

The description of this MultiProcessorUseCase.

Return type:

str

property keywords

Gets the keywords of this MultiProcessorUseCase.

Returns:

The keywords of this MultiProcessorUseCase.

Return type:

list[str]

property notes

Gets the notes of this MultiProcessorUseCase.

Returns:

The notes of this MultiProcessorUseCase.

Return type:

str

property processor_configurations

Gets the processor_configurations of this MultiProcessorUseCase.

Returns:

The processor_configurations of this MultiProcessorUseCase.

Return type:

list[ProcessorConfiguration]

swagger_types = {'description': 'str', 'keywords': 'list[str]', 'notes': 'str', 'processor_configurations': 'list[ProcessorConfiguration]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ParameterProviderReference(bundle=None, identifier=None, name=None, type=None)

Bases: object

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

ParameterProviderReference - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bundle=None, identifier=None, name=None, type=None)

ParameterProviderReference - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bundle

Gets the bundle of this ParameterProviderReference.

Returns:

The bundle of this ParameterProviderReference.

Return type:

Bundle

property identifier

Gets the identifier of this ParameterProviderReference. The identifier of the parameter provider

Returns:

The identifier of this ParameterProviderReference.

Return type:

str

property name

Gets the name of this ParameterProviderReference. The name of the parameter provider

Returns:

The name of this ParameterProviderReference.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ParameterProviderReference. The fully qualified name of the parameter provider class.

Returns:

The type of this ParameterProviderReference.

Return type:

str

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

Bases: object

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

Permissions - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(can_delete=None, can_read=None, can_write=None)

Permissions - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property can_delete

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

Returns:

The can_delete of this Permissions.

Return type:

bool

property 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

property 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

class nipyapi.registry.models.Position(x=None, y=None)

Bases: object

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

Position - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(x=None, y=None)

Position - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'x': 'x', 'y': 'y'}

swagger_types = {'x': 'float', 'y': 'float'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property x

Gets the x of this Position. The x coordinate.

Returns:

The x of this Position.

Return type:

float

property y

Gets the y of this Position. The y coordinate.

Returns:

The y of this Position.

Return type:

float

class nipyapi.registry.models.ProcessorConfiguration(configuration=None, processor_class_name=None)

Bases: object

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

ProcessorConfiguration - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(configuration=None, processor_class_name=None)

ProcessorConfiguration - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'configuration': 'configuration', 'processor_class_name': 'processorClassName'}

property configuration

Gets the configuration of this ProcessorConfiguration.

Returns:

The configuration of this ProcessorConfiguration.

Return type:

str

property processor_class_name

Gets the processor_class_name of this ProcessorConfiguration.

Returns:

The processor_class_name of this ProcessorConfiguration.

Return type:

str

swagger_types = {'configuration': 'str', 'processor_class_name': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ProvidedServiceAPI(artifact_id=None, class_name=None, group_id=None, version=None)

Bases: object

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

ProvidedServiceAPI - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(artifact_id=None, class_name=None, group_id=None, version=None)

ProvidedServiceAPI - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property artifact_id

Gets the artifact_id of this ProvidedServiceAPI. The artifact id of the service API being provided

Returns:

The artifact_id of this ProvidedServiceAPI.

Return type:

str

attribute_map = {'artifact_id': 'artifactId', 'class_name': 'className', 'group_id': 'groupId', 'version': 'version'}

property class_name

Gets the class_name of this ProvidedServiceAPI. The class name of the service API being provided

Returns:

The class_name of this ProvidedServiceAPI.

Return type:

str

property group_id

Gets the group_id of this ProvidedServiceAPI. The group id of the service API being provided

Returns:

The group_id of this ProvidedServiceAPI.

Return type:

str

swagger_types = {'artifact_id': 'str', 'class_name': 'str', 'group_id': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this ProvidedServiceAPI. The version of the service API being provided

Returns:

The version of this ProvidedServiceAPI.

Return type:

str

class nipyapi.registry.models.RegistryAbout(registry_about_version=None)

Bases: object

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

RegistryAbout - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(registry_about_version=None)

RegistryAbout - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'registry_about_version': 'registryAboutVersion'}

property registry_about_version

Gets the registry_about_version of this RegistryAbout. The version string for this Nifi Registry

Returns:

The registry_about_version of this RegistryAbout.

Return type:

str

swagger_types = {'registry_about_version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.RegistryConfiguration(supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, supports_managed_authorizer=None)

Bases: object

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

RegistryConfiguration - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(supports_configurable_authorizer=None, supports_configurable_users_and_groups=None, supports_managed_authorizer=None)

RegistryConfiguration - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'supports_configurable_authorizer': 'supportsConfigurableAuthorizer', 'supports_configurable_users_and_groups': 'supportsConfigurableUsersAndGroups', 'supports_managed_authorizer': 'supportsManagedAuthorizer'}

property supports_configurable_authorizer

Gets the supports_configurable_authorizer of this RegistryConfiguration. Whether this NiFi Registry supports a configurable authorizer.

Returns:

The supports_configurable_authorizer of this RegistryConfiguration.

Return type:

bool

property supports_configurable_users_and_groups

Gets the supports_configurable_users_and_groups of this RegistryConfiguration. Whether this NiFi Registry supports configurable users and groups.

Returns:

The supports_configurable_users_and_groups of this RegistryConfiguration.

Return type:

bool

property supports_managed_authorizer

Gets the supports_managed_authorizer of this RegistryConfiguration. Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.

Returns:

The supports_managed_authorizer of this RegistryConfiguration.

Return type:

bool

swagger_types = {'supports_configurable_authorizer': 'bool', 'supports_configurable_users_and_groups': 'bool', 'supports_managed_authorizer': 'bool'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.Relationship(auto_terminated=None, description=None, name=None)

Bases: object

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

Relationship - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(auto_terminated=None, description=None, name=None)

Relationship - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property auto_terminated

Gets the auto_terminated of this Relationship. Whether or not the relationship is auto-terminated by default

Returns:

The auto_terminated of this Relationship.

Return type:

bool

property description

Gets the description of this Relationship. The description of the relationship

Returns:

The description of this Relationship.

Return type:

str

property name

Gets the name of this Relationship. The name of the relationship

Returns:

The name of this Relationship.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.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

__eq__(other)

Returns true if both objects are equal

__init__(identifier=None, name=None)

Resource - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property identifier

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

Returns:

The identifier of this Resource.

Return type:

str

property 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

class nipyapi.registry.models.ResourceDefinition(cardinality=None, resource_types=None)

Bases: object

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

ResourceDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cardinality=None, resource_types=None)

ResourceDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cardinality': 'cardinality', 'resource_types': 'resourceTypes'}

property cardinality

Gets the cardinality of this ResourceDefinition. The cardinality of the resource definition

Returns:

The cardinality of this ResourceDefinition.

Return type:

str

property resource_types

Gets the resource_types of this ResourceDefinition. The types of resources

Returns:

The resource_types of this ResourceDefinition.

Return type:

list[str]

swagger_types = {'cardinality': 'str', 'resource_types': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.ResourcePermissions(any_top_level_resource=None, buckets=None, policies=None, proxy=None, tenants=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

__eq__(other)

Returns true if both objects are equal

__init__(any_top_level_resource=None, buckets=None, policies=None, proxy=None, tenants=None)

ResourcePermissions - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property any_top_level_resource

Gets the any_top_level_resource of this ResourcePermissions.

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

property buckets

Gets the buckets of this ResourcePermissions.

Returns:

The buckets of this ResourcePermissions.

Return type:

Permissions

property policies

Gets the policies of this ResourcePermissions.

Returns:

The policies of this ResourcePermissions.

Return type:

Permissions

property proxy

Gets the proxy of this ResourcePermissions.

Returns:

The proxy of this ResourcePermissions.

Return type:

Permissions

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

property tenants

Gets the tenants of this ResourcePermissions.

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

class nipyapi.registry.models.Restricted(general_restriction_explanation=None, restrictions=None)

Bases: object

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

Restricted - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(general_restriction_explanation=None, restrictions=None)

Restricted - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'general_restriction_explanation': 'generalRestrictionExplanation', 'restrictions': 'restrictions'}

property general_restriction_explanation

Gets the general_restriction_explanation of this Restricted. The general restriction for the extension, or null if only specific restrictions exist

Returns:

The general_restriction_explanation of this Restricted.

Return type:

str

property restrictions

Gets the restrictions of this Restricted. The specific restrictions

Returns:

The restrictions of this Restricted.

Return type:

list[Restriction]

swagger_types = {'general_restriction_explanation': 'str', 'restrictions': 'list[Restriction]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.Restriction(explanation=None, required_permission=None)

Bases: object

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

Restriction - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(explanation=None, required_permission=None)

Restriction - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property explanation

Gets the explanation of this Restriction. The explanation of this restriction

Returns:

The explanation of this Restriction.

Return type:

str

property required_permission

Gets the required_permission of this Restriction. The permission required for this restriction

Returns:

The required_permission of this Restriction.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.RevisionInfo(client_id=None, last_modifier=None, version=None)

Bases: object

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

RevisionInfo - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(client_id=None, last_modifier=None, version=None)

RevisionInfo - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'client_id': 'clientId', 'last_modifier': 'lastModifier', 'version': 'version'}

property client_id

Gets the client_id of this RevisionInfo. A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back.

Returns:

The client_id of this RevisionInfo.

Return type:

str

property last_modifier

Gets the last_modifier of this RevisionInfo. The user that last modified the entity.

Returns:

The last_modifier of this RevisionInfo.

Return type:

str

swagger_types = {'client_id': 'str', 'last_modifier': 'str', 'version': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this RevisionInfo. NiFi Registry employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version.

Returns:

The version of this RevisionInfo.

Return type:

int

class nipyapi.registry.models.Stateful(description=None, scopes=None)

Bases: object

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

Stateful - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, scopes=None)

Stateful - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this Stateful. The description for how the extension stores state

Returns:

The description of this Stateful.

Return type:

str

property scopes

Gets the scopes of this Stateful. The scopes used to store state

Returns:

The scopes of this Stateful.

Return type:

list[str]

swagger_types = {'description': 'str', 'scopes': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.SystemResourceConsideration(description=None, resource=None)

Bases: object

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

SystemResourceConsideration - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, resource=None)

SystemResourceConsideration - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property description

Gets the description of this SystemResourceConsideration. The description of how the resource is affected

Returns:

The description of this SystemResourceConsideration.

Return type:

str

property resource

Gets the resource of this SystemResourceConsideration. The resource to consider

Returns:

The resource of this SystemResourceConsideration.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.TagCount(count=None, tag=None)

Bases: object

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

TagCount - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(count=None, tag=None)

TagCount - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'count': 'count', 'tag': 'tag'}

property count

Gets the count of this TagCount. The number of occurrences of the given tag

Returns:

The count of this TagCount.

Return type:

int

swagger_types = {'count': 'int', 'tag': 'str'}

property tag

Gets the tag of this TagCount. The tag label

Returns:

The tag of this TagCount.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.Tenant(access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=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

__eq__(other)

Returns true if both objects are equal

__init__(access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=None, revision=None)

Tenant - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property access_policies

Gets the access_policies of this 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'}

property 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

property identifier

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

Returns:

The identifier of this Tenant.

Return type:

str

property 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

property resource_permissions

Gets the resource_permissions of this Tenant.

Returns:

The resource_permissions of this Tenant.

Return type:

ResourcePermissions

property revision

Gets the revision of this Tenant.

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

class nipyapi.registry.models.UriBuilder

Bases: object

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

UriBuilder - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__()

UriBuilder - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.UseCase(configuration=None, description=None, input_requirement=None, keywords=None, notes=None)

Bases: object

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

UseCase - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(configuration=None, description=None, input_requirement=None, keywords=None, notes=None)

UseCase - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'configuration': 'configuration', 'description': 'description', 'input_requirement': 'inputRequirement', 'keywords': 'keywords', 'notes': 'notes'}

property configuration

Gets the configuration of this UseCase.

Returns:

The configuration of this UseCase.

Return type:

str

property description

Gets the description of this UseCase.

Returns:

The description of this UseCase.

Return type:

str

property input_requirement

Gets the input_requirement of this UseCase.

Returns:

The input_requirement of this UseCase.

Return type:

str

property keywords

Gets the keywords of this UseCase.

Returns:

The keywords of this UseCase.

Return type:

list[str]

property notes

Gets the notes of this UseCase.

Returns:

The notes of this UseCase.

Return type:

str

swagger_types = {'configuration': 'str', 'description': 'str', 'input_requirement': 'str', 'keywords': 'list[str]', 'notes': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.User(access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=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

__eq__(other)

Returns true if both objects are equal

__init__(access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=None, revision=None, user_groups=None)

User - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property access_policies

Gets the access_policies of this 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'}

property 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

property identifier

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

Returns:

The identifier of this User.

Return type:

str

property 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

property resource_permissions

Gets the resource_permissions of this User.

Returns:

The resource_permissions of this User.

Return type:

ResourcePermissions

property revision

Gets the revision of this User.

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

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

class nipyapi.registry.models.UserGroup(access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=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

__eq__(other)

Returns true if both objects are equal

__init__(access_policies=None, configurable=None, identifier=None, identity=None, resource_permissions=None, revision=None, users=None)

UserGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property access_policies

Gets the access_policies of this 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'}

property 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

property identifier

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

Returns:

The identifier of this UserGroup.

Return type:

str

property 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

property resource_permissions

Gets the resource_permissions of this UserGroup.

Returns:

The resource_permissions of this UserGroup.

Return type:

ResourcePermissions

property revision

Gets the revision of this UserGroup.

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

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

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

Bases: object

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

VersionedAsset - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(identifier=None, name=None)

VersionedAsset - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property identifier

Gets the identifier of this VersionedAsset. The identifier of the asset

Returns:

The identifier of this VersionedAsset.

Return type:

str

property name

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

Returns:

The name of this VersionedAsset.

Return type:

str

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

VersionedConnection - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(back_pressure_data_size_threshold=None, back_pressure_object_threshold=None, bends=None, comments=None, component_type=None, destination=None, flow_file_expiration=None, group_identifier=None, identifier=None, instance_identifier=None, label_index=None, load_balance_compression=None, load_balance_strategy=None, name=None, partitioning_attribute=None, position=None, prioritizers=None, selected_relationships=None, source=None, z_index=None)

VersionedConnection - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'back_pressure_data_size_threshold': 'backPressureDataSizeThreshold', 'back_pressure_object_threshold': 'backPressureObjectThreshold', 'bends': 'bends', 'comments': 'comments', 'component_type': 'componentType', 'destination': 'destination', 'flow_file_expiration': 'flowFileExpiration', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label_index': 'labelIndex', 'load_balance_compression': 'loadBalanceCompression', 'load_balance_strategy': 'loadBalanceStrategy', 'name': 'name', 'partitioning_attribute': 'partitioningAttribute', 'position': 'position', 'prioritizers': 'prioritizers', 'selected_relationships': 'selectedRelationships', 'source': 'source', 'z_index': 'zIndex'}

property back_pressure_data_size_threshold

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

Returns:

The back_pressure_data_size_threshold of this VersionedConnection.

Return type:

str

property back_pressure_object_threshold

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

Returns:

The back_pressure_object_threshold of this VersionedConnection.

Return type:

int

property bends

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

Returns:

The bends of this VersionedConnection.

Return type:

list[Position]

property comments

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

Returns:

The comments of this VersionedConnection.

Return type:

str

property component_type

Gets the component_type of this VersionedConnection.

Returns:

The component_type of this VersionedConnection.

Return type:

str

property destination

Gets the destination of this VersionedConnection.

Returns:

The destination of this VersionedConnection.

Return type:

ConnectableComponent

property flow_file_expiration

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

Returns:

The flow_file_expiration of this VersionedConnection.

Return type:

str

property group_identifier

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

Returns:

The group_identifier of this VersionedConnection.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedConnection.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedConnection.

Return type:

str

property label_index

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

Returns:

The label_index of this VersionedConnection.

Return type:

int

property load_balance_compression

Gets the load_balance_compression of this VersionedConnection. Whether or not compression should be used when transferring FlowFiles between nodes Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details.

Returns:

The load_balance_compression of this VersionedConnection.

Return type:

str

property load_balance_strategy

Gets the load_balance_strategy of this VersionedConnection. The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details.

Returns:

The load_balance_strategy of this VersionedConnection.

Return type:

str

property name

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

Returns:

The name of this VersionedConnection.

Return type:

str

property partitioning_attribute

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

Returns:

The partitioning_attribute of this VersionedConnection.

Return type:

str

property position

Gets the position of this VersionedConnection.

Returns:

The position of this VersionedConnection.

Return type:

Position

property prioritizers

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

Returns:

The prioritizers of this VersionedConnection.

Return type:

list[str]

property selected_relationships

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

Returns:

The selected_relationships of this VersionedConnection.

Return type:

list[str]

property source

Gets the source of this VersionedConnection.

Returns:

The source of this VersionedConnection.

Return type:

ConnectableComponent

swagger_types = {'back_pressure_data_size_threshold': 'str', 'back_pressure_object_threshold': 'int', 'bends': 'list[Position]', 'comments': 'str', 'component_type': 'str', 'destination': 'ConnectableComponent', 'flow_file_expiration': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'label_index': 'int', 'load_balance_compression': 'str', 'load_balance_strategy': 'str', 'name': 'str', 'partitioning_attribute': 'str', 'position': 'Position', 'prioritizers': 'list[str]', 'selected_relationships': 'list[str]', 'source': 'ConnectableComponent', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property z_index

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

Returns:

The z_index of this VersionedConnection.

Return type:

int

class nipyapi.registry.models.VersionedControllerService(annotation_data=None, bulletin_level=None, bundle=None, comments=None, component_type=None, controller_service_apis=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, type=None)

Bases: object

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

VersionedControllerService - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, bulletin_level=None, bundle=None, comments=None, component_type=None, controller_service_apis=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, properties=None, property_descriptors=None, scheduled_state=None, type=None)

VersionedControllerService - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property annotation_data

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

Returns:

The annotation_data of this VersionedControllerService.

Return type:

str

attribute_map = {'annotation_data': 'annotationData', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'controller_service_apis': 'controllerServiceApis', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'scheduled_state': 'scheduledState', 'type': 'type'}

property bulletin_level

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

Returns:

The bulletin_level of this VersionedControllerService.

Return type:

str

property bundle

Gets the bundle of this VersionedControllerService.

Returns:

The bundle of this VersionedControllerService.

Return type:

Bundle

property comments

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

Returns:

The comments of this VersionedControllerService.

Return type:

str

property component_type

Gets the component_type of this VersionedControllerService.

Returns:

The component_type of this VersionedControllerService.

Return type:

str

property controller_service_apis

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

Returns:

The controller_service_apis of this VersionedControllerService.

Return type:

list[ControllerServiceAPI]

property group_identifier

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

Returns:

The group_identifier of this VersionedControllerService.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedControllerService.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedControllerService.

Return type:

str

property name

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

Returns:

The name of this VersionedControllerService.

Return type:

str

property position

Gets the position of this VersionedControllerService.

Returns:

The position of this VersionedControllerService.

Return type:

Position

property properties

Gets the properties of this VersionedControllerService. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:

The properties of this VersionedControllerService.

Return type:

dict(str, str)

property property_descriptors

Gets the property_descriptors of this VersionedControllerService. The property descriptors for the component.

Returns:

The property_descriptors of this VersionedControllerService.

Return type:

dict(str, VersionedPropertyDescriptor)

property scheduled_state

Gets the scheduled_state of this VersionedControllerService. The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED

Returns:

The scheduled_state of this VersionedControllerService.

Return type:

str

swagger_types = {'annotation_data': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'controller_service_apis': 'list[ControllerServiceAPI]', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this VersionedControllerService.

Return type:

str

class nipyapi.registry.models.VersionedFlow(bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, link=None, modified_timestamp=None, name=None, permissions=None, revision=None, type=None, version_count=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

__eq__(other)

Returns true if both objects are equal

__init__(bucket_identifier=None, bucket_name=None, created_timestamp=None, description=None, identifier=None, link=None, modified_timestamp=None, name=None, permissions=None, revision=None, type=None, version_count=None)

VersionedFlow - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property description

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

Returns:

The description of this VersionedFlow.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedFlow.

Return type:

str

property link

Gets the link of this VersionedFlow.

Returns:

The link of this VersionedFlow.

Return type:

Link

property 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

property name

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

Returns:

The name of this VersionedFlow.

Return type:

str

property permissions

Gets the permissions of this VersionedFlow.

Returns:

The permissions of this VersionedFlow.

Return type:

Permissions

property revision

Gets the revision of this VersionedFlow.

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': 'Link', '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

property type

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

Returns:

The type of this VersionedFlow.

Return type:

str

property 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

class nipyapi.registry.models.VersionedFlowCoordinates(branch=None, bucket_id=None, flow_id=None, latest=None, registry_id=None, storage_location=None, version=None)

Bases: object

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

VersionedFlowCoordinates - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(branch=None, bucket_id=None, flow_id=None, latest=None, registry_id=None, storage_location=None, version=None)

VersionedFlowCoordinates - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property branch

Gets the branch of this VersionedFlowCoordinates. The name of the branch that the flow resides in

Returns:

The branch of this VersionedFlowCoordinates.

Return type:

str

property bucket_id

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

Returns:

The bucket_id of this VersionedFlowCoordinates.

Return type:

str

property flow_id

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

Returns:

The flow_id of this VersionedFlowCoordinates.

Return type:

str

property latest

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

Returns:

The latest of this VersionedFlowCoordinates.

Return type:

bool

property registry_id

Gets the registry_id of this VersionedFlowCoordinates. The identifier of the Flow Registry that contains the flow

Returns:

The registry_id of this VersionedFlowCoordinates.

Return type:

str

property storage_location

Gets the storage_location of this VersionedFlowCoordinates. The location of the Flow Registry that stores the flow

Returns:

The storage_location of this VersionedFlowCoordinates.

Return type:

str

swagger_types = {'branch': 'str', 'bucket_id': 'str', 'flow_id': 'str', 'latest': 'bool', 'registry_id': 'str', 'storage_location': 'str', 'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

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

Returns:

The version of this VersionedFlowCoordinates.

Return type:

str

class nipyapi.registry.models.VersionedFlowDifference(bucket_id=None, component_difference_groups=None, flow_id=None, version_a=None, version_b=None)

Bases: object

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

VersionedFlowDifference - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket_id=None, component_difference_groups=None, flow_id=None, version_a=None, version_b=None)

VersionedFlowDifference - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'bucket_id': 'bucketId', 'component_difference_groups': 'componentDifferenceGroups', 'flow_id': 'flowId', 'version_a': 'versionA', 'version_b': 'versionB'}

property bucket_id

Gets the bucket_id of this VersionedFlowDifference. The id of the bucket that the flow is stored in.

Returns:

The bucket_id of this VersionedFlowDifference.

Return type:

str

property component_difference_groups

Gets the component_difference_groups of this VersionedFlowDifference.

Returns:

The component_difference_groups of this VersionedFlowDifference.

Return type:

list[ComponentDifferenceGroup]

property flow_id

Gets the flow_id of this VersionedFlowDifference. The id of the flow that is being examined.

Returns:

The flow_id of this VersionedFlowDifference.

Return type:

str

swagger_types = {'bucket_id': 'str', 'component_difference_groups': 'list[ComponentDifferenceGroup]', 'flow_id': 'str', 'version_a': 'int', 'version_b': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version_a

Gets the version_a of this VersionedFlowDifference. The earlier version from the diff operation.

Returns:

The version_a of this VersionedFlowDifference.

Return type:

int

property version_b

Gets the version_b of this VersionedFlowDifference. The latter version from the diff operation.

Returns:

The version_b of this VersionedFlowDifference.

Return type:

int

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

Bases: object

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

VersionedFlowSnapshot - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(bucket=None, external_controller_services=None, flow=None, flow_contents=None, flow_encoding_version=None, latest=None, parameter_contexts=None, parameter_providers=None, snapshot_metadata=None)

VersionedFlowSnapshot - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property bucket

Gets the bucket of this VersionedFlowSnapshot.

Returns:

The bucket of this VersionedFlowSnapshot.

Return type:

Bucket

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

property flow

Gets the flow of this VersionedFlowSnapshot.

Returns:

The flow of this VersionedFlowSnapshot.

Return type:

VersionedFlow

property flow_contents

Gets the flow_contents of this VersionedFlowSnapshot.

Returns:

The flow_contents of this VersionedFlowSnapshot.

Return type:

VersionedProcessGroup

property 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

property latest

Gets the latest of this VersionedFlowSnapshot.

Returns:

The latest of this VersionedFlowSnapshot.

Return type:

bool

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

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

property snapshot_metadata

Gets the snapshot_metadata of this VersionedFlowSnapshot.

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

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

Bases: object

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

VersionedFlowSnapshotMetadata - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(author=None, bucket_identifier=None, comments=None, flow_identifier=None, link=None, timestamp=None, version=None)

VersionedFlowSnapshotMetadata - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property 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

property 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

property 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

property 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

property link

Gets the link of this VersionedFlowSnapshotMetadata.

Returns:

The link of this VersionedFlowSnapshotMetadata.

Return type:

Link

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

property 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

property version

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

Returns:

The version of this VersionedFlowSnapshotMetadata.

Return type:

int

class nipyapi.registry.models.VersionedFunnel(comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None)

Bases: object

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

VersionedFunnel - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None)

VersionedFunnel - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property comments

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

Returns:

The comments of this VersionedFunnel.

Return type:

str

property component_type

Gets the component_type of this VersionedFunnel.

Returns:

The component_type of this VersionedFunnel.

Return type:

str

property group_identifier

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

Returns:

The group_identifier of this VersionedFunnel.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedFunnel.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedFunnel.

Return type:

str

property name

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

Returns:

The name of this VersionedFunnel.

Return type:

str

property position

Gets the position of this VersionedFunnel.

Returns:

The position of this VersionedFunnel.

Return type:

Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'position': 'Position'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

class nipyapi.registry.models.VersionedLabel(comments=None, component_type=None, group_identifier=None, height=None, identifier=None, instance_identifier=None, label=None, name=None, position=None, style=None, width=None, z_index=None)

Bases: object

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

VersionedLabel - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, group_identifier=None, height=None, identifier=None, instance_identifier=None, label=None, name=None, position=None, style=None, width=None, z_index=None)

VersionedLabel - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'height': 'height', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'label': 'label', 'name': 'name', 'position': 'position', 'style': 'style', 'width': 'width', 'z_index': 'zIndex'}

property comments

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

Returns:

The comments of this VersionedLabel.

Return type:

str

property component_type

Gets the component_type of this VersionedLabel.

Returns:

The component_type of this VersionedLabel.

Return type:

str

property group_identifier

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

Returns:

The group_identifier of this VersionedLabel.

Return type:

str

property height

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

Returns:

The height of this VersionedLabel.

Return type:

float

property identifier

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

Returns:

The identifier of this VersionedLabel.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedLabel.

Return type:

str

property label

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

Returns:

The label of this VersionedLabel.

Return type:

str

property name

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

Returns:

The name of this VersionedLabel.

Return type:

str

property position

Gets the position of this VersionedLabel.

Returns:

The position of this VersionedLabel.

Return type:

Position

property style

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

Returns:

The style of this VersionedLabel.

Return type:

dict(str, str)

swagger_types = {'comments': 'str', 'component_type': 'str', 'group_identifier': 'str', 'height': 'float', 'identifier': 'str', 'instance_identifier': 'str', 'label': 'str', 'name': 'str', 'position': 'Position', 'style': 'dict(str, str)', 'width': 'float', 'z_index': 'int'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property width

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

Returns:

The width of this VersionedLabel.

Return type:

float

property z_index

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

Returns:

The z_index of this VersionedLabel.

Return type:

int

class nipyapi.registry.models.VersionedParameter(description=None, name=None, provided=None, referenced_assets=None, sensitive=None, value=None)

Bases: object

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

VersionedParameter - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(description=None, name=None, provided=None, referenced_assets=None, sensitive=None, value=None)

VersionedParameter - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'description': 'description', 'name': 'name', 'provided': 'provided', 'referenced_assets': 'referencedAssets', 'sensitive': 'sensitive', 'value': 'value'}

property description

Gets the description of this VersionedParameter. The description of the param

Returns:

The description of this VersionedParameter.

Return type:

str

property name

Gets the name of this VersionedParameter. The name of the parameter

Returns:

The name of this VersionedParameter.

Return type:

str

property provided

Gets the provided of this VersionedParameter. Whether or not the parameter value is provided by a ParameterProvider

Returns:

The provided of this VersionedParameter.

Return type:

bool

property referenced_assets

Gets the referenced_assets of this VersionedParameter. The assets that are referenced by this parameter

Returns:

The referenced_assets of this VersionedParameter.

Return type:

list[VersionedAsset]

property sensitive

Gets the sensitive of this VersionedParameter. Whether or not the parameter value is sensitive

Returns:

The sensitive of this VersionedParameter.

Return type:

bool

swagger_types = {'description': 'str', 'name': 'str', 'provided': 'bool', 'referenced_assets': 'list[VersionedAsset]', 'sensitive': 'bool', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this VersionedParameter. The value of the parameter

Returns:

The value of this VersionedParameter.

Return type:

str

class nipyapi.registry.models.VersionedParameterContext(comments=None, component_type=None, description=None, group_identifier=None, identifier=None, inherited_parameter_contexts=None, instance_identifier=None, name=None, parameter_group_name=None, parameter_provider=None, parameters=None, position=None, synchronized=None)

Bases: object

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

VersionedParameterContext - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, description=None, group_identifier=None, identifier=None, inherited_parameter_contexts=None, instance_identifier=None, name=None, parameter_group_name=None, parameter_provider=None, parameters=None, position=None, synchronized=None)

VersionedParameterContext - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'description': 'description', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'inherited_parameter_contexts': 'inheritedParameterContexts', 'instance_identifier': 'instanceIdentifier', 'name': 'name', 'parameter_group_name': 'parameterGroupName', 'parameter_provider': 'parameterProvider', 'parameters': 'parameters', 'position': 'position', 'synchronized': 'synchronized'}

property comments

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

Returns:

The comments of this VersionedParameterContext.

Return type:

str

property component_type

Gets the component_type of this VersionedParameterContext.

Returns:

The component_type of this VersionedParameterContext.

Return type:

str

property description

Gets the description of this VersionedParameterContext. The description of the parameter context

Returns:

The description of this VersionedParameterContext.

Return type:

str

property group_identifier

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

Returns:

The group_identifier of this VersionedParameterContext.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedParameterContext.

Return type:

str

property inherited_parameter_contexts

Gets the inherited_parameter_contexts of this VersionedParameterContext. The names of additional parameter contexts from which to inherit parameters

Returns:

The inherited_parameter_contexts of this VersionedParameterContext.

Return type:

list[str]

property instance_identifier

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

Returns:

The instance_identifier of this VersionedParameterContext.

Return type:

str

property name

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

Returns:

The name of this VersionedParameterContext.

Return type:

str

property parameter_group_name

Gets the parameter_group_name of this VersionedParameterContext. The corresponding parameter group name fetched from the parameter provider, if applicable

Returns:

The parameter_group_name of this VersionedParameterContext.

Return type:

str

property parameter_provider

Gets the parameter_provider of this VersionedParameterContext. The identifier of an optional parameter provider

Returns:

The parameter_provider of this VersionedParameterContext.

Return type:

str

property parameters

Gets the parameters of this VersionedParameterContext. The parameters in the context

Returns:

The parameters of this VersionedParameterContext.

Return type:

list[VersionedParameter]

property position

Gets the position of this VersionedParameterContext.

Returns:

The position of this VersionedParameterContext.

Return type:

Position

swagger_types = {'comments': 'str', 'component_type': 'str', 'description': 'str', 'group_identifier': 'str', 'identifier': 'str', 'inherited_parameter_contexts': 'list[str]', 'instance_identifier': 'str', 'name': 'str', 'parameter_group_name': 'str', 'parameter_provider': 'str', 'parameters': 'list[VersionedParameter]', 'position': 'Position', 'synchronized': 'bool'}

property synchronized

Gets the synchronized of this VersionedParameterContext. True if the parameter provider is set and the context should receive updates when its parameters are next fetched

Returns:

The synchronized of this VersionedParameterContext.

Return type:

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

VersionedPort - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(allow_remote_access=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, port_function=None, position=None, scheduled_state=None, type=None)

VersionedPort - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property allow_remote_access

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

Returns:

The allow_remote_access of this VersionedPort.

Return type:

bool

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

property comments

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

Returns:

The comments of this VersionedPort.

Return type:

str

property component_type

Gets the component_type of this VersionedPort.

Returns:

The component_type of this VersionedPort.

Return type:

str

property concurrently_schedulable_task_count

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

Returns:

The concurrently_schedulable_task_count of this VersionedPort.

Return type:

int

property group_identifier

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

Returns:

The group_identifier of this VersionedPort.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedPort.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedPort.

Return type:

str

property name

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

Returns:

The name of this VersionedPort.

Return type:

str

property port_function

Gets the port_function of this VersionedPort. Specifies how the Port should function

Returns:

The port_function of this VersionedPort.

Return type:

str

property position

Gets the position of this VersionedPort.

Returns:

The position of this VersionedPort.

Return type:

Position

property scheduled_state

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

Returns:

The scheduled_state of this VersionedPort.

Return type:

str

swagger_types = {'allow_remote_access': 'bool', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'name': 'str', 'port_function': 'str', 'position': 'Position', 'scheduled_state': 'str', 'type': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this VersionedPort.

Return type:

str

class nipyapi.registry.models.VersionedProcessGroup(comments=None, component_type=None, connections=None, controller_services=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, execution_engine=None, flow_file_concurrency=None, flow_file_outbound_policy=None, funnels=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, labels=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_ports=None, parameter_context_name=None, position=None, process_groups=None, processors=None, remote_process_groups=None, scheduled_state=None, stateless_flow_timeout=None, versioned_flow_coordinates=None)

Bases: object

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

VersionedProcessGroup - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, component_type=None, connections=None, controller_services=None, default_back_pressure_data_size_threshold=None, default_back_pressure_object_threshold=None, default_flow_file_expiration=None, execution_engine=None, flow_file_concurrency=None, flow_file_outbound_policy=None, funnels=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, labels=None, log_file_suffix=None, max_concurrent_tasks=None, name=None, output_ports=None, parameter_context_name=None, position=None, process_groups=None, processors=None, remote_process_groups=None, scheduled_state=None, stateless_flow_timeout=None, versioned_flow_coordinates=None)

VersionedProcessGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'component_type': 'componentType', 'connections': 'connections', 'controller_services': 'controllerServices', 'default_back_pressure_data_size_threshold': 'defaultBackPressureDataSizeThreshold', 'default_back_pressure_object_threshold': 'defaultBackPressureObjectThreshold', 'default_flow_file_expiration': 'defaultFlowFileExpiration', 'execution_engine': 'executionEngine', 'flow_file_concurrency': 'flowFileConcurrency', 'flow_file_outbound_policy': 'flowFileOutboundPolicy', 'funnels': 'funnels', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'labels': 'labels', 'log_file_suffix': 'logFileSuffix', 'max_concurrent_tasks': 'maxConcurrentTasks', 'name': 'name', 'output_ports': 'outputPorts', 'parameter_context_name': 'parameterContextName', 'position': 'position', 'process_groups': 'processGroups', 'processors': 'processors', 'remote_process_groups': 'remoteProcessGroups', 'scheduled_state': 'scheduledState', 'stateless_flow_timeout': 'statelessFlowTimeout', 'versioned_flow_coordinates': 'versionedFlowCoordinates'}

property comments

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

Returns:

The comments of this VersionedProcessGroup.

Return type:

str

property component_type

Gets the component_type of this VersionedProcessGroup.

Returns:

The component_type of this VersionedProcessGroup.

Return type:

str

property connections

Gets the connections of this VersionedProcessGroup. The Connections

Returns:

The connections of this VersionedProcessGroup.

Return type:

list[VersionedConnection]

property controller_services

Gets the controller_services of this VersionedProcessGroup. The Controller Services

Returns:

The controller_services of this VersionedProcessGroup.

Return type:

list[VersionedControllerService]

property default_back_pressure_data_size_threshold

Gets the default_back_pressure_data_size_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.

Returns:

The default_back_pressure_data_size_threshold of this VersionedProcessGroup.

Return type:

str

property default_back_pressure_object_threshold

Gets the default_back_pressure_object_threshold of this VersionedProcessGroup. Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.

Returns:

The default_back_pressure_object_threshold of this VersionedProcessGroup.

Return type:

int

property default_flow_file_expiration

Gets the default_flow_file_expiration of this VersionedProcessGroup. The default FlowFile Expiration for this Process Group.

Returns:

The default_flow_file_expiration of this VersionedProcessGroup.

Return type:

str

property execution_engine

Gets the execution_engine of this VersionedProcessGroup. The Execution Engine that should be used to run the components within the group.

Returns:

The execution_engine of this VersionedProcessGroup.

Return type:

str

property flow_file_concurrency

Gets the flow_file_concurrency of this VersionedProcessGroup. The configured FlowFile Concurrency for the Process Group

Returns:

The flow_file_concurrency of this VersionedProcessGroup.

Return type:

str

property flow_file_outbound_policy

Gets the flow_file_outbound_policy of this VersionedProcessGroup. The FlowFile Outbound Policy for the Process Group

Returns:

The flow_file_outbound_policy of this VersionedProcessGroup.

Return type:

str

property funnels

Gets the funnels of this VersionedProcessGroup. The Funnels

Returns:

The funnels of this VersionedProcessGroup.

Return type:

list[VersionedFunnel]

property group_identifier

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

Returns:

The group_identifier of this VersionedProcessGroup.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedProcessGroup.

Return type:

str

property input_ports

Gets the input_ports of this VersionedProcessGroup. The Input Ports

Returns:

The input_ports of this VersionedProcessGroup.

Return type:

list[VersionedPort]

property instance_identifier

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

Returns:

The instance_identifier of this VersionedProcessGroup.

Return type:

str

property labels

Gets the labels of this VersionedProcessGroup. The Labels

Returns:

The labels of this VersionedProcessGroup.

Return type:

list[VersionedLabel]

property log_file_suffix

Gets the log_file_suffix of this VersionedProcessGroup. The log file suffix for this Process Group for dedicated logging.

Returns:

The log_file_suffix of this VersionedProcessGroup.

Return type:

str

property max_concurrent_tasks

Gets the max_concurrent_tasks of this VersionedProcessGroup. The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine

Returns:

The max_concurrent_tasks of this VersionedProcessGroup.

Return type:

int

property name

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

Returns:

The name of this VersionedProcessGroup.

Return type:

str

property output_ports

Gets the output_ports of this VersionedProcessGroup. The Output Ports

Returns:

The output_ports of this VersionedProcessGroup.

Return type:

list[VersionedPort]

property parameter_context_name

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

Returns:

The parameter_context_name of this VersionedProcessGroup.

Return type:

str

property position

Gets the position of this VersionedProcessGroup.

Returns:

The position of this VersionedProcessGroup.

Return type:

Position

property process_groups

Gets the process_groups of this VersionedProcessGroup. The child Process Groups

Returns:

The process_groups of this VersionedProcessGroup.

Return type:

list[VersionedProcessGroup]

property processors

Gets the processors of this VersionedProcessGroup. The Processors

Returns:

The processors of this VersionedProcessGroup.

Return type:

list[VersionedProcessor]

property remote_process_groups

Gets the remote_process_groups of this VersionedProcessGroup. The Remote Process Groups

Returns:

The remote_process_groups of this VersionedProcessGroup.

Return type:

list[VersionedRemoteProcessGroup]

property scheduled_state

Gets the scheduled_state of this VersionedProcessGroup. The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance.

Returns:

The scheduled_state of this VersionedProcessGroup.

Return type:

str

property stateless_flow_timeout

Gets the stateless_flow_timeout of this VersionedProcessGroup. The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure

Returns:

The stateless_flow_timeout of this VersionedProcessGroup.

Return type:

str

swagger_types = {'comments': 'str', 'component_type': 'str', 'connections': 'list[VersionedConnection]', 'controller_services': 'list[VersionedControllerService]', 'default_back_pressure_data_size_threshold': 'str', 'default_back_pressure_object_threshold': 'int', 'default_flow_file_expiration': 'str', 'execution_engine': 'str', 'flow_file_concurrency': 'str', 'flow_file_outbound_policy': 'str', 'funnels': 'list[VersionedFunnel]', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedPort]', 'instance_identifier': 'str', 'labels': 'list[VersionedLabel]', 'log_file_suffix': 'str', 'max_concurrent_tasks': 'int', 'name': 'str', 'output_ports': 'list[VersionedPort]', 'parameter_context_name': 'str', 'position': 'Position', 'process_groups': 'list[VersionedProcessGroup]', 'processors': 'list[VersionedProcessor]', 'remote_process_groups': 'list[VersionedRemoteProcessGroup]', 'scheduled_state': 'str', 'stateless_flow_timeout': 'str', 'versioned_flow_coordinates': 'VersionedFlowCoordinates'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property versioned_flow_coordinates

Gets the versioned_flow_coordinates of this VersionedProcessGroup.

Returns:

The versioned_flow_coordinates of this VersionedProcessGroup.

Return type:

VersionedFlowCoordinates

class nipyapi.registry.models.VersionedProcessor(annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, bundle=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, execution_node=None, group_identifier=None, identifier=None, instance_identifier=None, max_backoff_period=None, name=None, penalty_duration=None, position=None, properties=None, property_descriptors=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, style=None, type=None, yield_duration=None)

Bases: object

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

VersionedProcessor - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(annotation_data=None, auto_terminated_relationships=None, backoff_mechanism=None, bulletin_level=None, bundle=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, execution_node=None, group_identifier=None, identifier=None, instance_identifier=None, max_backoff_period=None, name=None, penalty_duration=None, position=None, properties=None, property_descriptors=None, retried_relationships=None, retry_count=None, run_duration_millis=None, scheduled_state=None, scheduling_period=None, scheduling_strategy=None, style=None, type=None, yield_duration=None)

VersionedProcessor - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

property annotation_data

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

Returns:

The annotation_data of this VersionedProcessor.

Return type:

str

attribute_map = {'annotation_data': 'annotationData', 'auto_terminated_relationships': 'autoTerminatedRelationships', 'backoff_mechanism': 'backoffMechanism', 'bulletin_level': 'bulletinLevel', 'bundle': 'bundle', 'comments': 'comments', 'component_type': 'componentType', 'concurrently_schedulable_task_count': 'concurrentlySchedulableTaskCount', 'execution_node': 'executionNode', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'instance_identifier': 'instanceIdentifier', 'max_backoff_period': 'maxBackoffPeriod', 'name': 'name', 'penalty_duration': 'penaltyDuration', 'position': 'position', 'properties': 'properties', 'property_descriptors': 'propertyDescriptors', 'retried_relationships': 'retriedRelationships', 'retry_count': 'retryCount', 'run_duration_millis': 'runDurationMillis', 'scheduled_state': 'scheduledState', 'scheduling_period': 'schedulingPeriod', 'scheduling_strategy': 'schedulingStrategy', 'style': 'style', 'type': 'type', 'yield_duration': 'yieldDuration'}

property auto_terminated_relationships

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

Returns:

The auto_terminated_relationships of this VersionedProcessor.

Return type:

list[str]

property backoff_mechanism

Gets the backoff_mechanism of this VersionedProcessor. Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR.

Returns:

The backoff_mechanism of this VersionedProcessor.

Return type:

str

property bulletin_level

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

Returns:

The bulletin_level of this VersionedProcessor.

Return type:

str

property bundle

Gets the bundle of this VersionedProcessor.

Returns:

The bundle of this VersionedProcessor.

Return type:

Bundle

property comments

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

Returns:

The comments of this VersionedProcessor.

Return type:

str

property component_type

Gets the component_type of this VersionedProcessor.

Returns:

The component_type of this VersionedProcessor.

Return type:

str

property concurrently_schedulable_task_count

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

Returns:

The concurrently_schedulable_task_count of this VersionedProcessor.

Return type:

int

property execution_node

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

Returns:

The execution_node of this VersionedProcessor.

Return type:

str

property group_identifier

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

Returns:

The group_identifier of this VersionedProcessor.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedProcessor.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedProcessor.

Return type:

str

property max_backoff_period

Gets the max_backoff_period of this VersionedProcessor. Maximum amount of time to be waited during a retry period.

Returns:

The max_backoff_period of this VersionedProcessor.

Return type:

str

property name

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

Returns:

The name of this VersionedProcessor.

Return type:

str

property penalty_duration

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

Returns:

The penalty_duration of this VersionedProcessor.

Return type:

str

property position

Gets the position of this VersionedProcessor.

Returns:

The position of this VersionedProcessor.

Return type:

Position

property properties

Gets the properties of this VersionedProcessor. The properties for the component. Properties whose value is not set will only contain the property name.

Returns:

The properties of this VersionedProcessor.

Return type:

dict(str, str)

property property_descriptors

Gets the property_descriptors of this VersionedProcessor. The property descriptors for the component.

Returns:

The property_descriptors of this VersionedProcessor.

Return type:

dict(str, VersionedPropertyDescriptor)

property retried_relationships

Gets the retried_relationships of this VersionedProcessor. All the relationships should be retried.

Returns:

The retried_relationships of this VersionedProcessor.

Return type:

list[str]

property retry_count

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

Returns:

The retry_count of this VersionedProcessor.

Return type:

int

property run_duration_millis

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

Returns:

The run_duration_millis of this VersionedProcessor.

Return type:

int

property scheduled_state

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

Returns:

The scheduled_state of this VersionedProcessor.

Return type:

str

property scheduling_period

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

Returns:

The scheduling_period of this VersionedProcessor.

Return type:

str

property scheduling_strategy

Gets the scheduling_strategy of this VersionedProcessor. Indicates how the processor should be scheduled to run.

Returns:

The scheduling_strategy of this VersionedProcessor.

Return type:

str

property style

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

Returns:

The style of this VersionedProcessor.

Return type:

dict(str, str)

swagger_types = {'annotation_data': 'str', 'auto_terminated_relationships': 'list[str]', 'backoff_mechanism': 'str', 'bulletin_level': 'str', 'bundle': 'Bundle', 'comments': 'str', 'component_type': 'str', 'concurrently_schedulable_task_count': 'int', 'execution_node': 'str', 'group_identifier': 'str', 'identifier': 'str', 'instance_identifier': 'str', 'max_backoff_period': 'str', 'name': 'str', 'penalty_duration': 'str', 'position': 'Position', 'properties': 'dict(str, str)', 'property_descriptors': 'dict(str, VersionedPropertyDescriptor)', 'retried_relationships': 'list[str]', 'retry_count': 'int', 'run_duration_millis': 'int', 'scheduled_state': 'str', 'scheduling_period': 'str', 'scheduling_strategy': 'str', 'style': 'dict(str, str)', 'type': 'str', 'yield_duration': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

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

Returns:

The type of this VersionedProcessor.

Return type:

str

property yield_duration

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

Returns:

The yield_duration of this VersionedProcessor.

Return type:

str

class nipyapi.registry.models.VersionedPropertyDescriptor(display_name=None, dynamic=None, identifies_controller_service=None, name=None, resource_definition=None, sensitive=None)

Bases: object

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

VersionedPropertyDescriptor - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(display_name=None, dynamic=None, identifies_controller_service=None, name=None, resource_definition=None, sensitive=None)

VersionedPropertyDescriptor - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property display_name

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

Returns:

The display_name of this VersionedPropertyDescriptor.

Return type:

str

property dynamic

Gets the dynamic of this VersionedPropertyDescriptor. Whether or not the property is user-defined

Returns:

The dynamic of this VersionedPropertyDescriptor.

Return type:

bool

property identifies_controller_service

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

Returns:

The identifies_controller_service of this VersionedPropertyDescriptor.

Return type:

bool

property name

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

Returns:

The name of this VersionedPropertyDescriptor.

Return type:

str

property resource_definition

Gets the resource_definition of this VersionedPropertyDescriptor.

Returns:

The resource_definition of this VersionedPropertyDescriptor.

Return type:

VersionedResourceDefinition

property sensitive

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

Returns:

The sensitive of this VersionedPropertyDescriptor.

Return type:

bool

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

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

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

Bases: object

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

VersionedRemoteGroupPort - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(batch_size=None, comments=None, component_type=None, concurrently_schedulable_task_count=None, group_identifier=None, identifier=None, instance_identifier=None, name=None, position=None, remote_group_id=None, scheduled_state=None, target_id=None, use_compression=None)

VersionedRemoteGroupPort - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

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

property batch_size

Gets the batch_size of this VersionedRemoteGroupPort.

Returns:

The batch_size of this VersionedRemoteGroupPort.

Return type:

BatchSize

property comments

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

Returns:

The comments of this VersionedRemoteGroupPort.

Return type:

str

property component_type

Gets the component_type of this VersionedRemoteGroupPort.

Returns:

The component_type of this VersionedRemoteGroupPort.

Return type:

str

property concurrently_schedulable_task_count

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

Returns:

The concurrently_schedulable_task_count of this VersionedRemoteGroupPort.

Return type:

int

property group_identifier

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

Returns:

The group_identifier of this VersionedRemoteGroupPort.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedRemoteGroupPort.

Return type:

str

property instance_identifier

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

Returns:

The instance_identifier of this VersionedRemoteGroupPort.

Return type:

str

property name

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

Returns:

The name of this VersionedRemoteGroupPort.

Return type:

str

property position

Gets the position of this VersionedRemoteGroupPort.

Returns:

The position of this VersionedRemoteGroupPort.

Return type:

Position

property remote_group_id

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

Returns:

The remote_group_id of this VersionedRemoteGroupPort.

Return type:

str

property scheduled_state

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

Returns:

The scheduled_state of this VersionedRemoteGroupPort.

Return type:

str

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

property target_id

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

Returns:

The target_id of this VersionedRemoteGroupPort.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property use_compression

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

Returns:

The use_compression of this VersionedRemoteGroupPort.

Return type:

bool

class nipyapi.registry.models.VersionedRemoteProcessGroup(comments=None, communications_timeout=None, component_type=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, local_network_interface=None, name=None, output_ports=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_uris=None, transport_protocol=None, yield_duration=None)

Bases: object

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

VersionedRemoteProcessGroup - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(comments=None, communications_timeout=None, component_type=None, group_identifier=None, identifier=None, input_ports=None, instance_identifier=None, local_network_interface=None, name=None, output_ports=None, position=None, proxy_host=None, proxy_password=None, proxy_port=None, proxy_user=None, target_uris=None, transport_protocol=None, yield_duration=None)

VersionedRemoteProcessGroup - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'comments': 'comments', 'communications_timeout': 'communicationsTimeout', 'component_type': 'componentType', 'group_identifier': 'groupIdentifier', 'identifier': 'identifier', 'input_ports': 'inputPorts', 'instance_identifier': 'instanceIdentifier', 'local_network_interface': 'localNetworkInterface', 'name': 'name', 'output_ports': 'outputPorts', 'position': 'position', 'proxy_host': 'proxyHost', 'proxy_password': 'proxyPassword', 'proxy_port': 'proxyPort', 'proxy_user': 'proxyUser', 'target_uris': 'targetUris', 'transport_protocol': 'transportProtocol', 'yield_duration': 'yieldDuration'}

property comments

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

Returns:

The comments of this VersionedRemoteProcessGroup.

Return type:

str

property communications_timeout

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

Returns:

The communications_timeout of this VersionedRemoteProcessGroup.

Return type:

str

property component_type

Gets the component_type of this VersionedRemoteProcessGroup.

Returns:

The component_type of this VersionedRemoteProcessGroup.

Return type:

str

property group_identifier

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

Returns:

The group_identifier of this VersionedRemoteProcessGroup.

Return type:

str

property identifier

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

Returns:

The identifier of this VersionedRemoteProcessGroup.

Return type:

str

property input_ports

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

Returns:

The input_ports of this VersionedRemoteProcessGroup.

Return type:

list[VersionedRemoteGroupPort]

property instance_identifier

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

Returns:

The instance_identifier of this VersionedRemoteProcessGroup.

Return type:

str

property local_network_interface

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

Returns:

The local_network_interface of this VersionedRemoteProcessGroup.

Return type:

str

property name

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

Returns:

The name of this VersionedRemoteProcessGroup.

Return type:

str

property output_ports

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

Returns:

The output_ports of this VersionedRemoteProcessGroup.

Return type:

list[VersionedRemoteGroupPort]

property position

Gets the position of this VersionedRemoteProcessGroup.

Returns:

The position of this VersionedRemoteProcessGroup.

Return type:

Position

property proxy_host

Gets the proxy_host of this VersionedRemoteProcessGroup.

Returns:

The proxy_host of this VersionedRemoteProcessGroup.

Return type:

str

property proxy_password

Gets the proxy_password of this VersionedRemoteProcessGroup.

Returns:

The proxy_password of this VersionedRemoteProcessGroup.

Return type:

str

property proxy_port

Gets the proxy_port of this VersionedRemoteProcessGroup.

Returns:

The proxy_port of this VersionedRemoteProcessGroup.

Return type:

int

property proxy_user

Gets the proxy_user of this VersionedRemoteProcessGroup.

Returns:

The proxy_user of this VersionedRemoteProcessGroup.

Return type:

str

swagger_types = {'comments': 'str', 'communications_timeout': 'str', 'component_type': 'str', 'group_identifier': 'str', 'identifier': 'str', 'input_ports': 'list[VersionedRemoteGroupPort]', 'instance_identifier': 'str', 'local_network_interface': 'str', 'name': 'str', 'output_ports': 'list[VersionedRemoteGroupPort]', 'position': 'Position', 'proxy_host': 'str', 'proxy_password': 'str', 'proxy_port': 'int', 'proxy_user': 'str', 'target_uris': 'str', 'transport_protocol': 'str', 'yield_duration': 'str'}

property target_uris

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

Returns:

The target_uris of this VersionedRemoteProcessGroup.

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property transport_protocol

Gets the transport_protocol of this VersionedRemoteProcessGroup. The Transport Protocol that is used for Site-to-Site communications. Possible returned values: RAW, HTTP.

Returns:

The transport_protocol of this VersionedRemoteProcessGroup.

Return type:

str

property yield_duration

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

Returns:

The yield_duration of this VersionedRemoteProcessGroup.

Return type:

str

class nipyapi.registry.models.VersionedResourceDefinition(cardinality=None, resource_types=None)

Bases: object

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

VersionedResourceDefinition - a model defined in Swagger

__eq__(other)

Returns true if both objects are equal

__init__(cardinality=None, resource_types=None)

VersionedResourceDefinition - a model defined in Swagger

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

attribute_map = {'cardinality': 'cardinality', 'resource_types': 'resourceTypes'}

property cardinality

Gets the cardinality of this VersionedResourceDefinition. The cardinality of the resource

Returns:

The cardinality of this VersionedResourceDefinition.

Return type:

str

property resource_types

Gets the resource_types of this VersionedResourceDefinition. The types of resource that the Property Descriptor is allowed to reference

Returns:

The resource_types of this VersionedResourceDefinition.

Return type:

list[str]

swagger_types = {'cardinality': 'str', 'resource_types': 'list[str]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model