Struct camunda_client::models::task_query_dto::TaskQueryDto

pub struct TaskQueryDto {
    pub process_instance_id: Option<String>,
    pub process_instance_id_in: Option<Vec<String>>,
    pub process_instance_business_key: Option<String>,
    pub process_instance_business_key_expression: Option<String>,
    pub process_instance_business_key_in: Option<Vec<String>>,
    pub process_instance_business_key_like: Option<String>,
    pub process_instance_business_key_like_expression: Option<String>,
    pub process_definition_id: Option<String>,
    pub process_definition_key: Option<String>,
    pub process_definition_key_in: Option<Vec<String>>,
    pub process_definition_name: Option<String>,
    pub process_definition_name_like: Option<String>,
    pub execution_id: Option<String>,
    pub case_instance_id: Option<String>,
    pub case_instance_business_key: Option<String>,
    pub case_instance_business_key_like: Option<String>,
    pub case_definition_id: Option<String>,
    pub case_definition_key: Option<String>,
    pub case_definition_name: Option<String>,
    pub case_definition_name_like: Option<String>,
    pub case_execution_id: Option<String>,
    pub activity_instance_id_in: Option<Vec<String>>,
    pub tenant_id_in: Option<Vec<String>>,
    pub without_tenant_id: Option<bool>,
    pub assignee: Option<String>,
    pub assignee_expression: Option<String>,
    pub assignee_like: Option<String>,
    pub assignee_like_expression: Option<String>,
    pub assignee_in: Option<Vec<String>>,
    pub owner: Option<String>,
    pub owner_expression: Option<String>,
    pub candidate_group: Option<String>,
    pub candidate_group_expression: Option<String>,
    pub candidate_user: Option<String>,
    pub candidate_user_expression: Option<String>,
    pub include_assigned_tasks: Option<bool>,
    pub involved_user: Option<String>,
    pub involved_user_expression: Option<String>,
    pub assigned: Option<bool>,
    pub unassigned: Option<bool>,
    pub task_definition_key: Option<String>,
    pub task_definition_key_in: Option<Vec<String>>,
    pub task_definition_key_like: Option<String>,
    pub name: Option<String>,
    pub name_not_equal: Option<String>,
    pub name_like: Option<String>,
    pub name_not_like: Option<String>,
    pub description: Option<String>,
    pub description_like: Option<String>,
    pub priority: Option<i32>,
    pub max_priority: Option<i32>,
    pub min_priority: Option<i32>,
    pub due_date: Option<String>,
    pub due_date_expression: Option<String>,
    pub due_after: Option<String>,
    pub due_after_expression: Option<String>,
    pub due_before: Option<String>,
    pub due_before_expression: Option<String>,
    pub follow_up_date: Option<String>,
    pub follow_up_date_expression: Option<String>,
    pub follow_up_after: Option<String>,
    pub follow_up_after_expression: Option<String>,
    pub follow_up_before: Option<String>,
    pub follow_up_before_expression: Option<String>,
    pub follow_up_before_or_not_existent: Option<String>,
    pub follow_up_before_or_not_existent_expression: Option<String>,
    pub created_on: Option<String>,
    pub created_on_expression: Option<String>,
    pub created_after: Option<String>,
    pub created_after_expression: Option<String>,
    pub created_before: Option<String>,
    pub created_before_expression: Option<String>,
    pub delegation_state: Option<DelegationState>,
    pub candidate_groups: Option<Vec<String>>,
    pub candidate_groups_expression: Option<String>,
    pub with_candidate_groups: Option<bool>,
    pub without_candidate_groups: Option<bool>,
    pub with_candidate_users: Option<bool>,
    pub without_candidate_users: Option<bool>,
    pub active: Option<bool>,
    pub suspended: Option<bool>,
    pub task_variables: Option<Vec<VariableQueryParameterDto>>,
    pub process_variables: Option<Vec<VariableQueryParameterDto>>,
    pub case_instance_variables: Option<Vec<VariableQueryParameterDto>>,
    pub variable_names_ignore_case: Option<bool>,
    pub variable_values_ignore_case: Option<bool>,
    pub parent_task_id: Option<String>,
    pub or_queries: Option<Vec<TaskQueryDto>>,
    pub sorting: Option<Vec<TaskQueryDtoSorting>>,
}

TaskQueryDto : A Task query which defines a group of Tasks.

Fields

process_instance_id: Option<String>

Restrict to tasks that belong to process instances with the given id.

process_instance_id_in: Option<Vec<String>>

Restrict to tasks that belong to process instances with the given ids.

process_instance_business_key: Option<String>

Restrict to tasks that belong to process instances with the given business key.

process_instance_business_key_expression: Option<String>

Restrict to tasks that belong to process instances with the given business key which is described by an expression. See the user guide for more information on available functions.

process_instance_business_key_in: Option<Vec<String>>

Restrict to tasks that belong to process instances with one of the give business keys. The keys need to be in a comma-separated list.

process_instance_business_key_like: Option<String>

Restrict to tasks that have a process instance business key that has the parameter value as a substring.

process_instance_business_key_like_expression: Option<String>

Restrict to tasks that have a process instance business key that has the parameter value as a substring and is described by an expression. See the user guide for more information on available functions.

process_definition_id: Option<String>

Restrict to tasks that belong to a process definition with the given id.

process_definition_key: Option<String>

Restrict to tasks that belong to a process definition with the given key.

process_definition_key_in: Option<Vec<String>>

Restrict to tasks that belong to a process definition with one of the given keys. The keys need to be in a comma-separated list.

process_definition_name: Option<String>

Restrict to tasks that belong to a process definition with the given name.

process_definition_name_like: Option<String>

Restrict to tasks that have a process definition name that has the parameter value as a substring.

execution_id: Option<String>

Restrict to tasks that belong to an execution with the given id.

case_instance_id: Option<String>

Restrict to tasks that belong to case instances with the given id.

case_instance_business_key: Option<String>

Restrict to tasks that belong to case instances with the given business key.

case_instance_business_key_like: Option<String>

Restrict to tasks that have a case instance business key that has the parameter value as a substring.

case_definition_id: Option<String>

Restrict to tasks that belong to a case definition with the given id.

case_definition_key: Option<String>

Restrict to tasks that belong to a case definition with the given key.

case_definition_name: Option<String>

Restrict to tasks that belong to a case definition with the given name.

case_definition_name_like: Option<String>

Restrict to tasks that have a case definition name that has the parameter value as a substring.

case_execution_id: Option<String>

Restrict to tasks that belong to a case execution with the given id.

activity_instance_id_in: Option<Vec<String>>

Only include tasks which belong to one of the passed and comma-separated activity instance ids.

tenant_id_in: Option<Vec<String>>

Only include tasks which belong to one of the passed and comma-separated tenant ids.

without_tenant_id: Option<bool>

Only include tasks which belong to no tenant. Value may only be true, as false is the default behavior.

assignee: Option<String>

Restrict to tasks that the given user is assigned to.

assignee_expression: Option<String>

Restrict to tasks that the user described by the given expression is assigned to. See the user guide for more information on available functions.

assignee_like: Option<String>

Restrict to tasks that have an assignee that has the parameter value as a substring.

assignee_like_expression: Option<String>

Restrict to tasks that have an assignee that has the parameter value described by the given expression as a substring. See the user guide for more information on available functions.

assignee_in: Option<Vec<String>>

Only include tasks which are assigned to one of the passed and comma-separated user ids.

owner: Option<String>

Restrict to tasks that the given user owns.

owner_expression: Option<String>

Restrict to tasks that the user described by the given expression owns. See the user guide for more information on available functions.

candidate_group: Option<String>

Only include tasks that are offered to the given group.

candidate_group_expression: Option<String>

Only include tasks that are offered to the group described by the given expression. See the user guide for more information on available functions.

candidate_user: Option<String>

Only include tasks that are offered to the given user or to one of his groups.

candidate_user_expression: Option<String>

Only include tasks that are offered to the user described by the given expression. See the user guide for more information on available functions.

include_assigned_tasks: Option<bool>

Also include tasks that are assigned to users in candidate queries. Default is to only include tasks that are not assigned to any user if you query by candidate user or group(s).

involved_user: Option<String>

Only include tasks that the given user is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee).

involved_user_expression: Option<String>

Only include tasks that the user described by the given expression is involved in. A user is involved in a task if an identity link exists between task and user (e.g., the user is the assignee). See the user guide for more information on available functions.

assigned: Option<bool>

If set to true, restricts the query to all tasks that are assigned.

unassigned: Option<bool>

If set to true, restricts the query to all tasks that are unassigned.

task_definition_key: Option<String>

Restrict to tasks that have the given key.

task_definition_key_in: Option<Vec<String>>

Restrict to tasks that have one of the given keys. The keys need to be in a comma-separated list.

task_definition_key_like: Option<String>

Restrict to tasks that have a key that has the parameter value as a substring.

name: Option<String>

Restrict to tasks that have the given name.

name_not_equal: Option<String>

Restrict to tasks that do not have the given name.

name_like: Option<String>

Restrict to tasks that have a name with the given parameter value as substring.

name_not_like: Option<String>

Restrict to tasks that do not have a name with the given parameter value as substring.

description: Option<String>

Restrict to tasks that have the given description.

description_like: Option<String>

Restrict to tasks that have a description that has the parameter value as a substring.

priority: Option<i32>

Restrict to tasks that have the given priority.

max_priority: Option<i32>

Restrict to tasks that have a lower or equal priority.

min_priority: Option<i32>

Restrict to tasks that have a higher or equal priority.

due_date: Option<String>

Restrict to tasks that are due on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.546+0200.

due_date_expression: Option<String>

Restrict to tasks that are due on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

due_after: Option<String>

Restrict to tasks that are due after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.435+0200.

due_after_expression: Option<String>

Restrict to tasks that are due after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

due_before: Option<String>

Restrict to tasks that are due before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.243+0200.

due_before_expression: Option<String>

Restrict to tasks that are due before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

follow_up_date: Option<String>

Restrict to tasks that have a followUp date on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.342+0200.

follow_up_date_expression: Option<String>

Restrict to tasks that have a followUp date on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

follow_up_after: Option<String>

Restrict to tasks that have a followUp date after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.542+0200.

follow_up_after_expression: Option<String>

Restrict to tasks that have a followUp date after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

follow_up_before: Option<String>

Restrict to tasks that have a followUp date before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.234+0200.

follow_up_before_expression: Option<String>

Restrict to tasks that have a followUp date before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

follow_up_before_or_not_existent: Option<String>

Restrict to tasks that have no followUp date or a followUp date before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.432+0200. The typical use case is to query all active tasks for a user for a given date.

follow_up_before_or_not_existent_expression: Option<String>

Restrict to tasks that have no followUp date or a followUp date before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

created_on: Option<String>

Restrict to tasks that were created on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.324+0200.

created_on_expression: Option<String>

Restrict to tasks that were created on the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

created_after: Option<String>

Restrict to tasks that were created after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.342+0200.

created_after_expression: Option<String>

Restrict to tasks that were created after the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

created_before: Option<String>

Restrict to tasks that were created before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.332+0200.

created_before_expression: Option<String>

Restrict to tasks that were created before the date described by the given expression. See the user guide for more information on available functions. The expression must evaluate to a java.util.Date or org.joda.time.DateTime object.

delegation_state: Option<DelegationState>

Restrict to tasks that are in the given delegation state. Valid values are PENDING and RESOLVED.

candidate_groups: Option<Vec<String>>

Restrict to tasks that are offered to any of the given candidate groups. Takes a comma-separated list of group names, so for example developers,support,sales.

candidate_groups_expression: Option<String>

Restrict to tasks that are offered to any of the candidate groups described by the given expression. See the user guide for more information on available functions. The expression must evaluate to java.util.List of Strings.

with_candidate_groups: Option<bool>

Only include tasks which have a candidate group. Value may only be true, as false is the default behavior.

without_candidate_groups: Option<bool>

Only include tasks which have no candidate group. Value may only be true, as false is the default behavior.

with_candidate_users: Option<bool>

Only include tasks which have a candidate user. Value may only be true, as false is the default behavior.

without_candidate_users: Option<bool>

Only include tasks which have no candidate users. Value may only be true, as false is the default behavior.

active: Option<bool>

Only include active tasks. Value may only be true, as false is the default behavior.

suspended: Option<bool>

Only include suspended tasks. Value may only be true, as false is the default behavior.

task_variables: Option<Vec<VariableQueryParameterDto>>

A JSON array to only include tasks that have variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters.

process_variables: Option<Vec<VariableQueryParameterDto>>

A JSON array to only include tasks that belong to a process instance with variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters.

case_instance_variables: Option<Vec<VariableQueryParameterDto>>

A JSON array to only include tasks that belong to a case instance with variables with certain values. The array consists of JSON objects with three properties name, operator and value. name is the variable name, operator is the comparison operator to be used and value the variable value. value may be of type String, Number or Boolean. Valid operator values are: eq - equal to; neq - not equal to; gt - greater than; gteq - greater than or equal to; lt - lower than; lteq - lower than or equal to; like. key and value may not contain underscore or comma characters.

variable_names_ignore_case: Option<bool>

Match all variable names in this query case-insensitively. If set variableName and variablename are treated as equal.

variable_values_ignore_case: Option<bool>

Match all variable values in this query case-insensitively. If set variableValue and variablevalue are treated as equal.

parent_task_id: Option<String>

Restrict query to all tasks that are sub tasks of the given task. Takes a task id.

or_queries: Option<Vec<TaskQueryDto>>

A JSON array of nested task queries with OR semantics. A task matches a nested query if it fulfills at least one of the query's predicates. With multiple nested queries, a task must fulfill at least one predicate of each query (Conjunctive Normal Form). All task query properties can be used except for: sorting, withCandidateGroups, withoutCandidateGroups, withCandidateUsers, withoutCandidateUsers See the User guide for more information about OR queries.

sorting: Option<Vec<TaskQueryDtoSorting>>

Apply sorting of the result

Implementations

impl TaskQueryDto

pub fn new() -> TaskQueryDto

A Task query which defines a group of Tasks.

Trait Implementations

impl Clone for TaskQueryDto

fn clone(&self) -> TaskQueryDto

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskQueryDto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskQueryDto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<TaskQueryDto> for TaskQueryDto

fn eq(&self, other: &TaskQueryDto) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TaskQueryDto) -> bool

This method tests for !=.

impl Serialize for TaskQueryDto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TaskQueryDto