kappa_sdk.UserTask#

class kappa_sdk.UserTask(field_id, well_id, custom_workflow_id, user_task_id, name, user_task_instance_id, data_types_catalog, outputs, plots, files, field_api, processing_api, plot_dto_converter, user_task_dto_converter)[source]#

User task object.

Presents a KAPPA Automate user task information object.

Attributes

UserTask.custom_workflow_id

Get the custom workflow id of the UserTask object.

UserTask.documents

Gets the list of the documents under this UserTask.

UserTask.files

Gets the list of the files under this UserTask.

UserTask.id

Gets the id of the UserTask object.

UserTask.inputs

Retrieves the user task inputs.

UserTask.name

Gets the name of the UserTask.

UserTask.outputs

Gets the list of outputs of the UserTask.

UserTask.plots

Gets the list of the plot instances of the UserTask.

UserTask.user_task_definition_name

Gets the user task definition name of the UserTask object.

UserTask.user_task_instance_id

Gets the user task id (processing service) of the UserTask object.

Methods

UserTask.create_plot(plot_name[, pane_name, ...])

Create a Kappa Automate Plot instance under the user task

UserTask.delete()

Delete the User Task

UserTask.rename(new_name)

Rename the User Task
Parameters:

  • field_id (str)

  • well_id (str)

  • custom_workflow_id (str | None)

  • user_task_id (str)

  • name (str)

  • user_task_instance_id (str)

  • data_types_catalog (FieldDataTypesCatalog)

  • outputs (List[Data])

  • plots (List[Plot])

  • files (List[File])

  • field_api (FieldAPI)

  • processing_api (ProcessingAPI)

  • plot_dto_converter (PlotDtoConverter)

  • user_task_dto_converter (UserTaskDtoConverter)

On this page