Package io.camunda.client.protocol.rest

Class MessageSubscriptionResult

java.lang.Object
io.camunda.client.protocol.rest.MessageSubscriptionResult
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class MessageSubscriptionResult extends Object
MessageSubscriptionResult

  • Field Details

  • Constructor Details

    • MessageSubscriptionResult

      public MessageSubscriptionResult()

  • Method Details

    • messageSubscriptionKey

      public MessageSubscriptionResult messageSubscriptionKey(@Nonnull String messageSubscriptionKey)

    • getMessageSubscriptionKey

      @Nonnull public String getMessageSubscriptionKey()
      The message subscription key associated with this message subscription.
      Returns:
      messageSubscriptionKey

    • setMessageSubscriptionKey

      public void setMessageSubscriptionKey(@Nonnull String messageSubscriptionKey)

    • processDefinitionId

      public MessageSubscriptionResult processDefinitionId(@Nonnull String processDefinitionId)

    • getProcessDefinitionId

      @Nonnull public String getProcessDefinitionId()
      The process definition ID associated with this message subscription.
      Returns:
      processDefinitionId

    • setProcessDefinitionId

      public void setProcessDefinitionId(@Nonnull String processDefinitionId)

    • processDefinitionKey

      public MessageSubscriptionResult processDefinitionKey(@Nullable String processDefinitionKey)

    • getProcessDefinitionKey

      @Nullable public String getProcessDefinitionKey()
      The process definition key associated with this message subscription.
      Returns:
      processDefinitionKey

    • setProcessDefinitionKey

      public void setProcessDefinitionKey(@Nullable String processDefinitionKey)

    • processInstanceKey

      public MessageSubscriptionResult processInstanceKey(@Nullable String processInstanceKey)

    • getProcessInstanceKey

      @Nullable public String getProcessInstanceKey()
      The process instance key associated with this message subscription. Only populated for intermediate event entities.
      Returns:
      processInstanceKey

    • setProcessInstanceKey

      public void setProcessInstanceKey(@Nullable String processInstanceKey)

    • rootProcessInstanceKey

      public MessageSubscriptionResult rootProcessInstanceKey(@Nullable String rootProcessInstanceKey)

    • getRootProcessInstanceKey

      @Nullable public String getRootProcessInstanceKey()
      The key of the root process instance. The root process instance is the top-level ancestor in the process instance hierarchy. This field is only present for data belonging to process instance hierarchies created in version 8.9 or later.
      Returns:
      rootProcessInstanceKey

    • setRootProcessInstanceKey

      public void setRootProcessInstanceKey(@Nullable String rootProcessInstanceKey)

    • elementId

      public MessageSubscriptionResult elementId(@Nonnull String elementId)

    • getElementId

      @Nonnull public String getElementId()
      The element ID associated with this message subscription.
      Returns:
      elementId

    • setElementId

      public void setElementId(@Nonnull String elementId)

    • elementInstanceKey

      public MessageSubscriptionResult elementInstanceKey(@Nullable String elementInstanceKey)

    • getElementInstanceKey

      @Nullable public String getElementInstanceKey()
      The element instance key associated with this message subscription. Only populated for intermediate event entities.
      Returns:
      elementInstanceKey

    • setElementInstanceKey

      public void setElementInstanceKey(@Nullable String elementInstanceKey)

    • messageSubscriptionState

      public MessageSubscriptionResult messageSubscriptionState(@Nonnull MessageSubscriptionStateEnum messageSubscriptionState)

    • getMessageSubscriptionState

      @Nonnull public MessageSubscriptionStateEnum getMessageSubscriptionState()
      Get messageSubscriptionState
      Returns:
      messageSubscriptionState

    • setMessageSubscriptionState

      public void setMessageSubscriptionState(@Nonnull MessageSubscriptionStateEnum messageSubscriptionState)

    • lastUpdatedDate

      public MessageSubscriptionResult lastUpdatedDate(@Nonnull String lastUpdatedDate)

    • getLastUpdatedDate

      @Nonnull public String getLastUpdatedDate()
      The last updated date of the message subscription.
      Returns:
      lastUpdatedDate

    • setLastUpdatedDate

      public void setLastUpdatedDate(@Nonnull String lastUpdatedDate)

    • messageName

      public MessageSubscriptionResult messageName(@Nonnull String messageName)

    • getMessageName

      @Nonnull public String getMessageName()
      The name of the message associated with the message subscription.
      Returns:
      messageName

    • setMessageName

      public void setMessageName(@Nonnull String messageName)

    • correlationKey

      public MessageSubscriptionResult correlationKey(@Nullable String correlationKey)

    • getCorrelationKey

      @Nullable public String getCorrelationKey()
      The correlation key of the message subscription.
      Returns:
      correlationKey

    • setCorrelationKey

      public void setCorrelationKey(@Nullable String correlationKey)

    • messageSubscriptionType

      public MessageSubscriptionResult messageSubscriptionType(@Nonnull MessageSubscriptionTypeEnum messageSubscriptionType)

    • getMessageSubscriptionType

      @Nonnull public MessageSubscriptionTypeEnum getMessageSubscriptionType()
      Get messageSubscriptionType
      Returns:
      messageSubscriptionType

    • setMessageSubscriptionType

      public void setMessageSubscriptionType(@Nonnull MessageSubscriptionTypeEnum messageSubscriptionType)

    • toolProperties

      public MessageSubscriptionResult toolProperties(@Nonnull Map<String,String> toolProperties)

    • putToolPropertiesItem

      public MessageSubscriptionResult putToolPropertiesItem(String key, String toolPropertiesItem)

    • getToolProperties

      @Nonnull public Map<String,String> getToolProperties()
      The subset of `zeebe:properties` extension properties whose keys start with the `io.camunda.tool:` prefix, extracted from the BPMN element associated with this subscription. Empty object when no matching properties are defined.
      Returns:
      toolProperties

    • setToolProperties

      public void setToolProperties(@Nonnull Map<String,String> toolProperties)

    • processDefinitionName

      public MessageSubscriptionResult processDefinitionName(@Nullable String processDefinitionName)

    • getProcessDefinitionName

      @Nullable public String getProcessDefinitionName()
      The name of the process definition associated with this message subscription.
      Returns:
      processDefinitionName

    • setProcessDefinitionName

      public void setProcessDefinitionName(@Nullable String processDefinitionName)

    • processDefinitionVersion

      public MessageSubscriptionResult processDefinitionVersion(@Nullable Integer processDefinitionVersion)

    • getProcessDefinitionVersion

      @Nullable public Integer getProcessDefinitionVersion()
      The version of the process definition associated with this message subscription.
      Returns:
      processDefinitionVersion

    • setProcessDefinitionVersion

      public void setProcessDefinitionVersion(@Nullable Integer processDefinitionVersion)

    • toolName

      public MessageSubscriptionResult toolName(@Nullable String toolName)

    • getToolName

      @Nullable public String getToolName()
      Tool name extracted from the `io.camunda.tool:name` zeebe:property. Null when the property is absent.
      Returns:
      toolName

    • setToolName

      public void setToolName(@Nullable String toolName)

    • inboundConnectorType

      public MessageSubscriptionResult inboundConnectorType(@Nullable String inboundConnectorType)

    • getInboundConnectorType

      @Nullable public String getInboundConnectorType()
      Inbound connector type extracted from the `inbound.type` zeebe:property. Null when the property is absent.
      Returns:
      inboundConnectorType

    • setInboundConnectorType

      public void setInboundConnectorType(@Nullable String inboundConnectorType)

    • tenantId

      public MessageSubscriptionResult tenantId(@Nonnull String tenantId)

    • getTenantId

      @Nonnull public String getTenantId()
      The unique identifier of the tenant.
      Returns:
      tenantId

    • setTenantId

      public void setTenantId(@Nonnull 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