SignalDto (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- org.openapitools.client.model.SignalDto

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-09-29T11:12:16.359+02:00[Europe/Berlin]")
public class SignalDto
extends Object

SignalDto

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_EXECUTION_ID`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_TENANT_ID`
`static String`	`SERIALIZED_NAME_VARIABLES`
`static String`	`SERIALIZED_NAME_WITHOUT_TENANT_ID`

Constructor Summary

Constructors
Constructor and Description

SignalDto()

Constructors
Constructor and Description
`SignalDto()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`SignalDto`	`executionId(String executionId)`
`String`	`getExecutionId()` Optionally specifies a single execution which is notified by the signal.
`String`	`getName()` The name of the signal to deliver.
`String`	`getTenantId()` Specifies a tenant to deliver the signal.
`Map<String,VariableValueDto>`	`getVariables()` A JSON object containing variable key-value pairs.
`Boolean`	`getWithoutTenantId()` If true the signal can only be received on executions or process definitions which belongs to no tenant.
`int`	`hashCode()`
`SignalDto`	`name(String name)`
`SignalDto`	`putVariablesItem(String key, VariableValueDto variablesItem)`
`void`	`setExecutionId(String executionId)`
`void`	`setName(String name)`
`void`	`setTenantId(String tenantId)`
`void`	`setVariables(Map<String,VariableValueDto> variables)`
`void`	`setWithoutTenantId(Boolean withoutTenantId)`
`SignalDto`	`tenantId(String tenantId)`
`String`	`toString()`
`SignalDto`	`variables(Map<String,VariableValueDto> variables)`
`SignalDto`	`withoutTenantId(Boolean withoutTenantId)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXECUTION_ID
```
public static final String SERIALIZED_NAME_EXECUTION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_VARIABLES
```
public static final String SERIALIZED_NAME_VARIABLES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TENANT_ID
```
public static final String SERIALIZED_NAME_TENANT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_WITHOUT_TENANT_ID
```
public static final String SERIALIZED_NAME_WITHOUT_TENANT_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SignalDto
```
public SignalDto()
```
- Method Detail
  - 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
  - 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
  - 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
  - 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
  - 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

Class SignalDto

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_NAME

SERIALIZED_NAME_EXECUTION_ID

SERIALIZED_NAME_VARIABLES

SERIALIZED_NAME_TENANT_ID

SERIALIZED_NAME_WITHOUT_TENANT_ID

Constructor Detail

SignalDto

Method Detail

name

getName

setName

executionId

getExecutionId

setExecutionId

variables

putVariablesItem

getVariables

setVariables

tenantId

getTenantId

setTenantId

withoutTenantId

getWithoutTenantId

setWithoutTenantId

equals

hashCode

toString