Python
Classes
Overview of the classes in the Python SDK
The Lume Python SDK is currently in beta. Please reach out to support if you have any questions, encounter any bugs, or have any feature requests.
Primary Classes
Job
Type representing details of a job. Returned in job fetching methods.
| Property | Description |
|---|---|
| id | Unique identifier of the job. |
| created_at | Date and time the job was created. |
| pipeline_id | ID of the pipeline the job is associated with. |
Workshop
Type representing details of a workshop. Returned in workshop fetching methods.
| Property | Description |
|---|---|
| id | Unique identifier of the workshop. |
| created_at | Date and time the workshop was created. |
| job_id | ID of the job the workshop is associated with. |
| pipeline_id | ID of the pipeline the workshop is associated with. |
| status | Status of the workshop. |
| updated_at | Date and time the workshop was last updated. |
Mapper
Type representing the mapped record of the data from the job.
| Property | Description |
|---|---|
| id | Unique identifier of the mapper. |
| status | Status of the mapping operation. |
| created_at | Timestamp when the mapper was created. |
| job_id | ID of the job associated with this mapper. |
| pipeline_id | ID of the pipeline used in this mapping. |
| mapped_data | Data that has been mapped. |
Pipeline
Type representing details of a pipeline. Returned in pipeline fetching methods.
| Property | Description |
|---|---|
| id | Unique identifier of the pipeline. |
| created_at | Date and time the pipeline was created. |
| name | Name of the pipeline. Must be unique within the organization. |
| description | Description of the pipeline. |
| target_schema_id | The target schema of the pipeline in JSON-schema format. |
| source_schema | The source schema of the pipeline, inferred from the pipeline’s jobs in JSON-schema format. |
| updated_at | Date and time the pipeline was last updated. |
Result
Type representing details of a result from a job or a task.
| Property | Description |
|---|---|
| id | Unique identifier of the result. |
| status | Status of the result. |
| created_at | Date and time the result was created. |
| updated_at | Date and time the result was last updated. |
Target
Type representing details of a target schema.
| Property | Description |
|---|---|
| id | The ID of the target schema. |
| name | The name of the target schema. |
| filename | The file name of the target schema. |
Parameter Data Models
PipelineCreatePayload
Payload for creating a new pipeline.
| Property | Description |
|---|---|
| name | Name of the pipeline. Must be unique within the organization. |
| description | Description of the pipeline. |
| target_schema | The target schema of the pipeline in JSON-schema format. |
PipelineUpdatePayload
Payload for updating an existing pipeline.
| Property | Description |
|---|---|
| name | Name of the pipeline. Must be unique within the organization. |
| description | Description of the pipeline. |
ResultMapper
Type representing the mapping details associated with a result.
| Property | Description |
|---|---|
| result_id | Identifier of the result this mapping belongs to. |
| index | Index of the record in the data set. |
| source_record | The original record before mapping. |
| mapped_record | The record after mapping. |
| message | A message associated with the mapping, if any. |