Package io.camunda.zeebe.client.protocol.rest

Class IncidentItem

java.lang.Object
io.camunda.zeebe.client.protocol.rest.IncidentItem
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-10-28T16:53:53.401346729Z[GMT]", comments="Generator version: 7.8.0") public class IncidentItem extends Object
IncidentItem

  • Field Details

  • Constructor Details

    • IncidentItem

      public IncidentItem()

  • Method Details

    • key

      public IncidentItem key(Long key)

    • getKey

      @Nullable public Long getKey()
      The assigned key, which acts as a unique identifier for this incident.
      Returns:
      key

    • setKey

      public void setKey(Long key)

    • processDefinitionKey

      public IncidentItem processDefinitionKey(Long processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public Long getProcessDefinitionKey()
      The process definition key associated to this incident.
      Returns:
      processDefinitionKey

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(Long processDefinitionKey)

    • processDefinitionId

      public IncidentItem processDefinitionId(String processDefinitionId)

    • getProcessDefinitionId

      @Nullable public String getProcessDefinitionId()
      The bpmn process id associated to this incident.
      Returns:
      processDefinitionId

    • setProcessDefinitionId

      public void setProcessDefinitionId(String processDefinitionId)

    • processInstanceKey

      public IncidentItem processInstanceKey(Long processInstanceKey)

    • getProcessInstanceKey

      @Nullable public Long getProcessInstanceKey()
      The process instance key associated to this incident.
      Returns:
      processInstanceKey

    • setProcessInstanceKey

      public void setProcessInstanceKey(Long processInstanceKey)

    • errorType

      public IncidentItem errorType(IncidentItem.ErrorTypeEnum errorType)

    • getErrorType

      @Nullable public IncidentItem.ErrorTypeEnum getErrorType()
      Incident error type with a defined set of values.
      Returns:
      errorType

    • setErrorType

      public void setErrorType(IncidentItem.ErrorTypeEnum errorType)

    • errorMessage

      public IncidentItem errorMessage(String errorMessage)

    • getErrorMessage

      @Nullable public String getErrorMessage()
      Error message which describes the error in more detail.
      Returns:
      errorMessage

    • setErrorMessage

      public void setErrorMessage(String errorMessage)

    • flowNodeId

      public IncidentItem flowNodeId(String flowNodeId)

    • getFlowNodeId

      @Nullable public String getFlowNodeId()
      The flow node id associated to this incident.
      Returns:
      flowNodeId

    • setFlowNodeId

      public void setFlowNodeId(String flowNodeId)

    • flowNodeInstanceKey

      public IncidentItem flowNodeInstanceKey(Long flowNodeInstanceKey)

    • getFlowNodeInstanceKey

      @Nullable public Long getFlowNodeInstanceKey()
      The flow node instance key associated to this incident.
      Returns:
      flowNodeInstanceKey

    • setFlowNodeInstanceKey

      public void setFlowNodeInstanceKey(Long flowNodeInstanceKey)

    • creationTime

      public IncidentItem creationTime(String creationTime)

    • getCreationTime

      @Nullable public String getCreationTime()
      Date of incident creation.
      Returns:
      creationTime

    • setCreationTime

      public void setCreationTime(String creationTime)

    • state

      public IncidentItem state(IncidentItem.StateEnum state)

    • getState

      @Nullable public IncidentItem.StateEnum getState()
      State of this incident with a defined set of values.
      Returns:
      state

    • setState

      public void setState(IncidentItem.StateEnum state)

    • jobKey

      public IncidentItem jobKey(Long jobKey)

    • getJobKey

      @Nullable public Long getJobKey()
      The job key, if exists, associated with this incident.
      Returns:
      jobKey

    • setJobKey

      public void setJobKey(Long jobKey)

    • treePath

      public IncidentItem treePath(String treePath)

    • getTreePath

      @Nullable public String getTreePath()
      The path from process instance via flow node ids and flow node instance keys leading to this incident.
      Returns:
      treePath

    • setTreePath

      public void setTreePath(String treePath)

    • tenantId

      public IncidentItem tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      The tenant id of the incident.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(String tenantId)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string