Package org.camunda.community.rest.client.dto

Class SignalDto

java.lang.Object
org.camunda.community.rest.client.dto.SignalDto
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class SignalDto extends Object
SignalDto

  • Field Details

  • Constructor Details

    • SignalDto

      public SignalDto()

  • Method Details

    • name

      public SignalDto name(String name)

    • getName

      @Nullable public String getName()
      The name of the signal to deliver. **Note**: This property is mandatory.
      Returns:
      name

    • setName

      public void setName(String name)

    • executionId

      public SignalDto executionId(String executionId)

    • getExecutionId

      @Nullable public String getExecutionId()
      Optionally specifies a single execution which is notified by the signal. **Note**: If no execution id is defined the signal is broadcasted to all subscribed handlers.
      Returns:
      executionId

    • getExecutionId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getExecutionId_JsonNullable()

    • setExecutionId_JsonNullable

      public void setExecutionId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> executionId)

    • setExecutionId

      public void setExecutionId(String executionId)

    • variables

      public SignalDto variables(Map<String,VariableValueDto> variables)

    • putVariablesItem

      public SignalDto putVariablesItem(String key, VariableValueDto variablesItem)

    • getVariables

      @Nullable public Map<String,VariableValueDto> getVariables()
      A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object.
      Returns:
      variables

    • getVariables_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> getVariables_JsonNullable()

    • setVariables_JsonNullable

      public void setVariables_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,VariableValueDto>> variables)

    • setVariables

      public void setVariables(Map<String,VariableValueDto> variables)

    • tenantId

      public SignalDto tenantId(String tenantId)

    • getTenantId

      @Nullable public String getTenantId()
      Specifies a tenant to deliver the signal. The signal can only be received on executions or process definitions which belongs to the given tenant. **Note**: Cannot be used in combination with executionId.
      Returns:
      tenantId

    • getTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTenantId_JsonNullable()

    • setTenantId_JsonNullable

      public void setTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tenantId)

    • setTenantId

      public void setTenantId(String tenantId)

    • withoutTenantId

      public SignalDto withoutTenantId(Boolean withoutTenantId)

    • getWithoutTenantId

      @Nullable public Boolean getWithoutTenantId()
      If true the signal can only be received on executions or process definitions which belongs to no tenant. Value may not be false as this is the default behavior. **Note**: Cannot be used in combination with `executionId`.
      Returns:
      withoutTenantId

    • getWithoutTenantId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<Boolean> getWithoutTenantId_JsonNullable()

    • setWithoutTenantId_JsonNullable

      public void setWithoutTenantId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> withoutTenantId)

    • setWithoutTenantId

      public void setWithoutTenantId(Boolean withoutTenantId)

    • 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