[−][src]Trait camunda_client::apis::ProcessInstanceApi

pub trait ProcessInstanceApi {
    fn delete_async_historic_query_based(
        &self, 
        delete_process_instances_dto: Option<DeleteProcessInstancesDto>
    ) -> Result<BatchDto, Error>;

    fn delete_process_instance(
        &self, 
        id: &str, 
        skip_custom_listeners: Option<bool>, 
        skip_io_mappings: Option<bool>, 
        skip_subprocesses: Option<bool>, 
        fail_if_not_exists: Option<bool>
    ) -> Result<(), Error>;

    fn delete_process_instance_variable(
        &self, 
        id: &str, 
        var_name: &str
    ) -> Result<(), Error>;

    fn delete_process_instances_async_operation(
        &self, 
        delete_process_instances_dto: Option<DeleteProcessInstancesDto>
    ) -> Result<BatchDto, Error>;

    fn get_activity_instance_tree(
        &self, 
        id: &str
    ) -> Result<ActivityInstanceDto, Error>;

    fn get_process_instance_variable(
        &self, 
        id: &str, 
        var_name: &str, 
        deserialize_value: Option<bool>
    ) -> Result<VariableValueDto, Error>;

    fn get_process_instance_variable_binary(
        &self, 
        id: &str, 
        var_name: &str
    ) -> Result<PathBuf, Error>;

    fn get_process_instance_variables(
        &self, 
        id: &str, 
        deserialize_value: Option<bool>
    ) -> Result<HashMap<String, VariableValueDto>, Error>;

    fn get_process_instances(
        &self, 
        sort_by: Option<&str>, 
        sort_order: Option<&str>, 
        first_result: Option<i32>, 
        max_results: Option<i32>, 
        process_instance_ids: Option<&str>, 
        business_key: Option<&str>, 
        business_key_like: Option<&str>, 
        case_instance_id: Option<&str>, 
        process_definition_id: Option<&str>, 
        process_definition_key: Option<&str>, 
        process_definition_key_in: Option<&str>, 
        process_definition_key_not_in: Option<&str>, 
        deployment_id: Option<&str>, 
        super_process_instance: Option<&str>, 
        sub_process_instance: Option<&str>, 
        super_case_instance: Option<&str>, 
        sub_case_instance: Option<&str>, 
        active: Option<bool>, 
        suspended: Option<bool>, 
        with_incident: Option<bool>, 
        incident_id: Option<&str>, 
        incident_type: Option<&str>, 
        incident_message: Option<&str>, 
        incident_message_like: Option<&str>, 
        tenant_id_in: Option<&str>, 
        without_tenant_id: Option<bool>, 
        process_definition_without_tenant_id: Option<bool>, 
        activity_id_in: Option<&str>, 
        root_process_instances: Option<bool>, 
        leaf_process_instances: Option<bool>, 
        variables: Option<&str>, 
        variable_names_ignore_case: Option<bool>, 
        variable_values_ignore_case: Option<bool>
    ) -> Result<Vec<ProcessInstanceDto>, Error>;

    fn get_process_instances_count(
        &self, 
        process_instance_ids: Option<&str>, 
        business_key: Option<&str>, 
        business_key_like: Option<&str>, 
        case_instance_id: Option<&str>, 
        process_definition_id: Option<&str>, 
        process_definition_key: Option<&str>, 
        process_definition_key_in: Option<&str>, 
        process_definition_key_not_in: Option<&str>, 
        deployment_id: Option<&str>, 
        super_process_instance: Option<&str>, 
        sub_process_instance: Option<&str>, 
        super_case_instance: Option<&str>, 
        sub_case_instance: Option<&str>, 
        active: Option<bool>, 
        suspended: Option<bool>, 
        with_incident: Option<bool>, 
        incident_id: Option<&str>, 
        incident_type: Option<&str>, 
        incident_message: Option<&str>, 
        incident_message_like: Option<&str>, 
        tenant_id_in: Option<&str>, 
        without_tenant_id: Option<bool>, 
        process_definition_without_tenant_id: Option<bool>, 
        activity_id_in: Option<&str>, 
        root_process_instances: Option<bool>, 
        leaf_process_instances: Option<bool>, 
        variables: Option<&str>, 
        variable_names_ignore_case: Option<bool>, 
        variable_values_ignore_case: Option<bool>
    ) -> Result<CountResultDto, Error>;

    fn modify_process_instance(
        &self, 
        id: &str, 
        process_instance_modification_dto: Option<ProcessInstanceModificationDto>
    ) -> Result<(), Error>;

    fn modify_process_instance_async_operation(
        &self, 
        id: &str, 
        process_instance_modification_dto: Option<ProcessInstanceModificationDto>
    ) -> Result<BatchDto, Error>;

    fn modify_process_instance_variables(
        &self, 
        id: &str, 
        patch_variables_dto: Option<PatchVariablesDto>
    ) -> Result<(), Error>;

    fn query_process_instances(
        &self, 
        first_result: Option<i32>, 
        max_results: Option<i32>, 
        process_instance_query_dto: Option<ProcessInstanceQueryDto>
    ) -> Result<Vec<ProcessInstanceDto>, Error>;

    fn query_process_instances_count(
        &self, 
        process_instance_query_dto: Option<ProcessInstanceQueryDto>
    ) -> Result<CountResultDto, Error>;

    fn set_process_instance_variable(
        &self, 
        id: &str, 
        var_name: &str, 
        variable_value_dto: Option<VariableValueDto>
    ) -> Result<(), Error>;

    fn set_process_instance_variable_binary(
        &self, 
        id: &str, 
        var_name: &str, 
        data: Option<PathBuf>, 
        value_type: Option<&str>
    ) -> Result<(), Error>;

    fn set_retries_by_process(
        &self, 
        set_job_retries_by_process_dto: Option<SetJobRetriesByProcessDto>
    ) -> Result<BatchDto, Error>;

    fn set_retries_by_process_historic_query_based(
        &self, 
        set_job_retries_by_process_dto: Option<SetJobRetriesByProcessDto>
    ) -> Result<BatchDto, Error>;

    fn update_suspension_state(
        &self, 
        process_instance_suspension_state_dto: Option<ProcessInstanceSuspensionStateDto>
    ) -> Result<(), Error>;

    fn update_suspension_state_async_operation(
        &self, 
        process_instance_suspension_state_async_dto: Option<ProcessInstanceSuspensionStateAsyncDto>
    ) -> Result<BatchDto, Error>;

    fn update_suspension_state_by_id(
        &self, 
        id: &str, 
        suspension_state_dto: Option<SuspensionStateDto>
    ) -> Result<(), Error>;
}

Required methods

fn delete_async_historic_query_based(
    &self,
    delete_process_instances_dto: Option<DeleteProcessInstancesDto>
) -> Result<BatchDto, Error>

fn delete_process_instance(
    &self,
    id: &str,
    skip_custom_listeners: Option<bool>,
    skip_io_mappings: Option<bool>,
    skip_subprocesses: Option<bool>,
    fail_if_not_exists: Option<bool>
) -> Result<(), Error>

fn delete_process_instance_variable(
    &self,
    id: &str,
    var_name: &str
) -> Result<(), Error>

fn delete_process_instances_async_operation(
    &self,
    delete_process_instances_dto: Option<DeleteProcessInstancesDto>
) -> Result<BatchDto, Error>

fn get_activity_instance_tree(
    &self,
    id: &str
) -> Result<ActivityInstanceDto, Error>

fn get_process_instance_variable(
    &self,
    id: &str,
    var_name: &str,
    deserialize_value: Option<bool>
) -> Result<VariableValueDto, Error>

fn get_process_instance_variable_binary(
    &self,
    id: &str,
    var_name: &str
) -> Result<PathBuf, Error>

fn get_process_instance_variables(
    &self,
    id: &str,
    deserialize_value: Option<bool>
) -> Result<HashMap<String, VariableValueDto>, Error>

fn get_process_instances(
    &self,
    sort_by: Option<&str>,
    sort_order: Option<&str>,
    first_result: Option<i32>,
    max_results: Option<i32>,
    process_instance_ids: Option<&str>,
    business_key: Option<&str>,
    business_key_like: Option<&str>,
    case_instance_id: Option<&str>,
    process_definition_id: Option<&str>,
    process_definition_key: Option<&str>,
    process_definition_key_in: Option<&str>,
    process_definition_key_not_in: Option<&str>,
    deployment_id: Option<&str>,
    super_process_instance: Option<&str>,
    sub_process_instance: Option<&str>,
    super_case_instance: Option<&str>,
    sub_case_instance: Option<&str>,
    active: Option<bool>,
    suspended: Option<bool>,
    with_incident: Option<bool>,
    incident_id: Option<&str>,
    incident_type: Option<&str>,
    incident_message: Option<&str>,
    incident_message_like: Option<&str>,
    tenant_id_in: Option<&str>,
    without_tenant_id: Option<bool>,
    process_definition_without_tenant_id: Option<bool>,
    activity_id_in: Option<&str>,
    root_process_instances: Option<bool>,
    leaf_process_instances: Option<bool>,
    variables: Option<&str>,
    variable_names_ignore_case: Option<bool>,
    variable_values_ignore_case: Option<bool>
) -> Result<Vec<ProcessInstanceDto>, Error>

fn get_process_instances_count(
    &self,
    process_instance_ids: Option<&str>,
    business_key: Option<&str>,
    business_key_like: Option<&str>,
    case_instance_id: Option<&str>,
    process_definition_id: Option<&str>,
    process_definition_key: Option<&str>,
    process_definition_key_in: Option<&str>,
    process_definition_key_not_in: Option<&str>,
    deployment_id: Option<&str>,
    super_process_instance: Option<&str>,
    sub_process_instance: Option<&str>,
    super_case_instance: Option<&str>,
    sub_case_instance: Option<&str>,
    active: Option<bool>,
    suspended: Option<bool>,
    with_incident: Option<bool>,
    incident_id: Option<&str>,
    incident_type: Option<&str>,
    incident_message: Option<&str>,
    incident_message_like: Option<&str>,
    tenant_id_in: Option<&str>,
    without_tenant_id: Option<bool>,
    process_definition_without_tenant_id: Option<bool>,
    activity_id_in: Option<&str>,
    root_process_instances: Option<bool>,
    leaf_process_instances: Option<bool>,
    variables: Option<&str>,
    variable_names_ignore_case: Option<bool>,
    variable_values_ignore_case: Option<bool>
) -> Result<CountResultDto, Error>

fn modify_process_instance(
    &self,
    id: &str,
    process_instance_modification_dto: Option<ProcessInstanceModificationDto>
) -> Result<(), Error>

fn modify_process_instance_async_operation(
    &self,
    id: &str,
    process_instance_modification_dto: Option<ProcessInstanceModificationDto>
) -> Result<BatchDto, Error>

fn modify_process_instance_variables(
    &self,
    id: &str,
    patch_variables_dto: Option<PatchVariablesDto>
) -> Result<(), Error>

fn query_process_instances(
    &self,
    first_result: Option<i32>,
    max_results: Option<i32>,
    process_instance_query_dto: Option<ProcessInstanceQueryDto>
) -> Result<Vec<ProcessInstanceDto>, Error>

fn query_process_instances_count(
    &self,
    process_instance_query_dto: Option<ProcessInstanceQueryDto>
) -> Result<CountResultDto, Error>

fn set_process_instance_variable(
    &self,
    id: &str,
    var_name: &str,
    variable_value_dto: Option<VariableValueDto>
) -> Result<(), Error>

fn set_process_instance_variable_binary(
    &self,
    id: &str,
    var_name: &str,
    data: Option<PathBuf>,
    value_type: Option<&str>
) -> Result<(), Error>

fn set_retries_by_process(
    &self,
    set_job_retries_by_process_dto: Option<SetJobRetriesByProcessDto>
) -> Result<BatchDto, Error>

fn set_retries_by_process_historic_query_based(
    &self,
    set_job_retries_by_process_dto: Option<SetJobRetriesByProcessDto>
) -> Result<BatchDto, Error>

fn update_suspension_state(
    &self,
    process_instance_suspension_state_dto: Option<ProcessInstanceSuspensionStateDto>
) -> Result<(), Error>

fn update_suspension_state_async_operation(
    &self,
    process_instance_suspension_state_async_dto: Option<ProcessInstanceSuspensionStateAsyncDto>
) -> Result<BatchDto, Error>

fn update_suspension_state_by_id(
    &self,
    id: &str,
    suspension_state_dto: Option<SuspensionStateDto>
) -> Result<(), Error>

Loading content...

Implementors

impl ProcessInstanceApi for ProcessInstanceApiClient[src]

Loading content...