Classes

Common

GenericResource

PropertyTypeRequiredDefault
ownerstrtrue-
owner_informationOwnerInformationtrue-
idstrtrue-
namestrtrue-
descriptionstrtrue-
tags[str]true-
created_atdatetimetrue-
updated_atdatetimetrue-
notesUnion[str, None]true-
projectsProjecttrue-
home_projectinttrue-
permissionsinttrue-
resource_typeinttrue-

Paginated

PropertyTypeRequiredDefault
ippinttrue-
items[obj]true-
pageinttrue-
paginatedbooltrue-
total_itemsinttrue-

SearchParameterBase


Abstract class. Represents the search parameters that are used in several list functions.

PropertyTypeRequiredDefault
pageintfalseNone
limitintfalseNone
orderingSortOrderfalseNone
searchstrfalseNone

OwnerInformation

PropertyTypeRequiredDefault
ownerIdstrtrue-
typestrtrue-

UserOwnerInformation


Inherits: OwnerInformation

PropertyTypeRequiredDefault
first_namestrtrue-
last_namestrtrue-

GroupOwnerInformation


Inherits: OwnerInformation

PropertyTypeRequiredDefault
namestrtrue-
tags[str]true-

Connections

Connection


Representation of a connection.


Inherits: GenericResource

PropertyTypeRequiredDefault
connection_typeConnectionTypetrue-
key_idstrtrue-
key_namestrtrue-

CreateDatasetFromDatabase


Representation of the create request parameters.

PropertyTypeRequiredDefault
connection_idstrtrue-
connection_typeConnectionTypetrue-
connection_table_namestrtrue-
dt_namestrtrue-
access[DatabaseTablePrivilege]true-
resource_typeGenericResourceTypetrue-
dt_descriptionstrfalseNone
dt_notesstrfalseNone
dt_tags[str]falseNone
connection_schemastrfalseNone
target_projectstrfalseNone

DatabaseConnectionTableInformation


Representation of data table information from database connection.

PropertyTypeRequiredDefault
idstrtrue-
namestrtrue-
access[DatabaseTablePrivilege]false[]
dt_idstrfalseNone
dt_namestrfalseNone
schemastrfalseNone

DatabaseConnectionTableInformationSearchParameters


Representation of database connection specific search parameters.


Inherits: SearchParametersBase



PropertyTypeRequiredDefault
project_idstrfalseNone
sort_byDatabaseConnectionTableSortType
falseNone
tables_listing_modeTablesListingModefalseNone



DataTables

DataTableInformation


Inherits: GenericResource

PropertyTypeRequiredDefault
workflows[WorkflowInformation]true-
row_countinttrue-
data_sourceDataSourceInformationtrue-
lockedDatasetLocktrue-

DataTable


Inherits: DataTableInformation

PropertyTypeRequiredDefault
attributesdicttrue-
attributes_operatorAttributesOperatortrue-
dataset_type_specific_metadatadicttrue-

DataTableColumn

PropertyTypeRequiredDefault
namestrtrue-
indexinttrue-
typeRepresentationTypetrue-

DataTableContent

PropertyTypeRequiredDefault
total_countinttrue-
distinct_values[dict]true-
editablebooltrue-
row_unique_id_columnstrtrue-
filterable_information_idstrtrue-
schema[DataTableColumn]falseNone
records[dict]falseNone
errors[str]falseNone
total_filter_matchesintfalseNone
aggregation_metadata[dict]falseNone
download_link_idstrfalseNone

UploadedDataResponse

PropertyTypeRequiredDefault
dataDataTabletrue-
modified_datasetsModifiedDatasetNametrue-
fallback_data_tablesDataTabletrue-

ModifiedDatasetName

PropertyTypeRequiredDefault
old_dataset_namestrtrue-
new_dataset_namestrtrue-

DataSourceInformation

PropertyTypeRequiredDefault
idstrtrue-

CSVSourceInformation


Inherits: DataSourceInformation

PropertyTypeRequiredDefault
job_idtrue-

DatabaseTableConnectionSourceInformation


Inherits: DataSourceInformation

PropertyTypeRequiredDefault
access[DatabaseTablePrivilege]true-
database_connectionConnectiontrue-
table_namestrtrue-
table_schemastrtrue-

FilesystemFileConnectionSourceInformation


Inherits: DataSourceInformation

PropertyTypeRequiredDefault
filesystem_connectionConnectiontrue-
relative_file_pathstrtrue-
merge_patternFilesystemConnectionMergePatterntrue-

ParquetSourceInformation


Inherits: DataSourceInformation

PropertyTypeRequiredDefault
job_idstrtrue-

FilterableSourceInformation


Inherits: DataSourceInformation

PropertyTypeRequiredDefault
job_idstrtrue-
storage_typeDataTableStorageTypetrue-
external_connection_infoExternalConnectionInformationtrue-

VirtualDataSourceInformation


Inherits: DataSourceInformation

PropertyTypeRequiredDefault
vdt_source_idstrtrue-

FilesystemConnectionMergePattern

PropertyTypeRequiredDefault
merge_rulestrtrue-
file_namestrtrue-

ExternalConnectionInformation

PropertyTypeRequiredDefault
connectionConnectiontrue-
connection_typeConnectionTypetrue-

DatabaseTableConnectionInformation


Inherits: ExternalConnectionInformation

PropertyTypeRequiredDefault
table_namestrtrue-
schema[DatatableColumn]true-
access[DatabaseTablePrivilege]true-

CassandraTableConnectionInformation


Inherits: ExternalConnectionInformation

PropertyTypeRequiredDefault
table_namestrtrue-

Functions

FunctionExecutionError

PropertyTypeRequiredDefault
typestrtrue-
messagestrfalseNone
tracestrfalseNone
caused_by[]falseNone

FunctionExecutionResult

PropertyTypeRequiredDefault
statusFunctionExecutionStatustrue-
stdoutstrfalseNone
stderrstrfalseNone
responsedictfalseNone
error[FunctionExecutionError]falseNone

ProductionLines

ProductionLine [FunctionExecutionError]


Inherits: GenericResource

PropertyTypeRequiredDefault
version_numberinttrue-
workflow_sequence[ProductionLineSequenceEntry]true-
production_line_variable[dict]true-
job_naming_ruledictfalseNone
error[FunctionExecutionError]
falseNone

ProductionLineJob

PropertyTypeRequiredDefault
idstrtrue-
start_timedatetimetrue-
namestrtrue-
execution_numberinttrue-
production_lineProductionLinetrue-
stateProductionLineJobStatetrue-
canceledbooltrue-
execution_sequenceProductionLineJobEntrytrue-
overridden_values[dict]falseNone
end_timedatetimefalseNone
schedule_idstrfalseNone

ProductionLineJobEntry

PropertyTypeRequiredDefault
positioninttrue-

ProductionLineSequenceEntry

Abstract representation of a production line sequence entry

PropertyTypeRequiredDefault
positioninttrue-

Projects

Project

PropertyTypeRequiredDefault
idstrtrue-
project_typestrtrue-
namestrtrue-
ownerstrtrue-
descriptionstrtrue-
notesstrtrue-
tags[str]true-
created_atdatetimetrue-
updated_atdatetimetrue-
securedbooltrue-
owner_informationOwnerInformationtrue-

ProjectSearchParameters


Representation of project specific search parameters.


Inherits: SearchParametersBase

PropertyTypeRequiredDefault
sort_byResourceSortPropertyfalseNone

Users

User

PropertyTypeRequiredDefault
idstrtrue-
first_namestrtrue-
last_namestrtrue-
emailstrtrue-
usernamestrtrue-
super_adminbooltrue-
created_atdatetrue-
updated_atdatetrue-
groups[dict]true-
domains[dict]true-
modules[OneDataModule]true-
internal_accountbooltrue-
default_domainstrfalseNone
preferred_projects[dict]falseNone
user_variables[dict]falseNone

Workflows

Workflow

Inherits: GenericResource

PropertyTypeRequiredDefault
version_numberinttrue-
nodesdicttrue-
node_notesdicttrue-
auxiliaries[WorkflowAuxiliaries]true-
sources[dict]true-
sinks[dict]true-
groups[dict]true-
recent_executionstrtrue-
variables[dict]true-
job_naming_rulestrtrue-

WorkflowAuxiliaries

PropertyTypeRequiredDefault
typestrtrue-
xinttrue-
yinttrue-

WorkflowInformation

PropertyTypeRequiredDefault
ownerstrtrue-
idstrtrue-
namestrtrue-
descriptionstrtrue-
notesstrtrue-
tags[str]true-
projects[Project]true-
created_atdatetimetrue-
updated_atdatetimetrue-
owner_informationOwnerInformationtrue-
home_projectProjecttrue-
permissions[Permission]true-
resource_typeGenericResourceTypetrue-
recent_executionstrtrue-
version_numberinttrue-
recent_execution_in_workflowstrtrue-

WorkflowJob


Inherits: WorkflowJobShallow

PropertyTypeRequiredDefault
results[dict]true-
errors[dict]true-
warnings[dict]true-
variable_configurationdicttrue-

WorkflowJobShallow


Inherits: GenericResource

PropertyTypeRequiredDefault
start_timedatetimetrue-
end_timedatetimetrue-
workflow_idstrtrue-
workflow_versioninttrue-
workflow_namestrtrue-
workflow_permission[Permission]true-
execution_numberinttrue-
execution_stateJobExecutionStatetrue-
execution_contextJobExecutionContexttrue-
execution_context_metadatadicttrue-
schedule_idstrtrue-


Enums

AttributesOperator

  • AND = "AND"
  • OR = "OR"

ConnectionType

  • DB_CONNECTION = "DB_CONNECTION"
  • REST_API_CONNECTION = "REST_API_CONNECTION"
  • FILESYSTEM_CONNECTION = "FILESYSTEM_CONNECTION"
  • CASSANDRA_CONNECTION = "CASSANDRA_CONNECTION"

DatabaseConnectionTableSortType

  • NAME = "name"
  • SCHEMA = "schema"
  • DATASET = "dataset"

DatabaseTablePrivilege

  • READ = "READ"
  • APPEND = "APPEND"
  • REPLACE = "REPLACE"
  • UNKNOWN = "UNKNOWN"

DatasetLock

  • LOCKED = "LOCKED"
  • APPLIED_AUTHORIZATION_DIMENSIONS = "APPLIED_AUTHORIZATION_DIMENSIONS"
  • OPEN = "OPEN"

DataTableStorageType

  • CSV = "CSV"
  • KUDU = "KUDU"
  • PARQUET = "PARQUET"
  • ORC = "ORC"
  • POSTGRESQL = "POSTGRESQL"
  • EXTERNAL_STORAGE = "EXTERNAL_STORAGE"

FunctionExecutionStatus

  • SUCCESS = "SUCCESS"
  • FUNCTION_ERROR = "FUNCTION_ERROR"

GenericResourceType

  • DATA = "DATA"
  • WORKFLOW = "WORKFLOW"
  • WORKFLOW_JOB = "WORKFLOW_JOB"
  • DYNAMIC_REPORT = "DYNAMIC_REPORT"
  • KEY = "KEY"
  • PROCESS_MODEL = "PROCESS_MODEL"
  • SCHEDULE = "SCHEDULE"
  • MACHINE_LEARNING_MODEL = "MACHINE_LEARNING_MODEL"
  • DB_CONNECTION = "DB_CONNECTION"
  • PRODUCTION_LINE = "PRODUCTION_LINE"
  • PYTHON_MODEL = "PYTHON_MODEL"
  • MODEL_GROUP = "MODEL_GROUP"
  • FUNCTION = "FUNCTION"

JobExecutionState

  • INITIAL = "initial"
  • RUNNING = "running"
  • FAILED = "failed"
  • ABORTED = "aborted"
  • SUCCESS = "success"

JobExecutionContext

  • MANUAL = "MANUAL"
  • SCHEDULED = "SCHEDULED"
  • MICROSERVICE = "MICROSERVICE"
  • PRODUCTION_LINE = "PRODUCTION_LINE"
  • SCHEDULED_PRODUCTION_LINE = "SCHEDULED_PRODUCTION_LINE"
  • DEBUG = "DEBUG"

OneDataModule

  • DATAHUB = "DATAHUB"
  • MODELHUB = "MODELHUB"
  • PROCESSING_LIBRARY = "PROCESSING_LIBRARY"
  • USE_CASES = "USE_CASES"
  • APP_BUILDER = "APP_BUILDER"
  • APP_VIEWER = "APP_VIEWER"

Permission

  • READ = "READ"
  • WRITE = "WRITE"
  • CREATE = "CREATE"
  • DELETE = "DELETE"
  • EXECUTE = "EXECUTE"
  • SHARE = "SHARE"

ProductionLineJobState

  • INITIAL = "INITIAL"
  • SUCCESS = "SUCCESS"
  • FAILED = "FAILED"
  • RUNNING = "RUNNING"
  • ABORTED = "ABORTED"

RepresentationType

  • DOUBLE = "double"
  • STRING = "string"
  • NUMERIC = "numeric"
  • DATETIME = "datetime"
  • INT = "int"

ResourceSortProperty

  • NAME = "name"
  • OWNER = "owner"
  • UPDATED = "updated"
  • CREATED = "created"

SortOrder

  • ASC = "ASC"
  • DESC = "DESC"

TablesListingMode

  • SCHEMA_CONFIGURED_IN_THE_CONNECTION = "SCHEMA_CONFIGURED_IN_THE_CONNECTION"
  • ALL_SCHEMATA_EXCEPT_BLACKLISTED = "ALL_SCHEMATA_EXCEPT_BLACKLISTED"
  • ALL_SCHEMATA = "ALL_SCHEMATA"

UserSortProperty

  • FORENAME = "forename"
  • LASTNAME = "lastname"
  • EMAIL = "email"