Package io.camunda.client.protocol.rest

Class SignalBroadcastRequest

java.lang.Object

io.camunda.client.protocol.rest.SignalBroadcastRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-06-04T12:01:10.435788262Z[GMT]",
           comments="Generator version: 7.12.0")
public class SignalBroadcastRequest
extends Object

SignalBroadcastRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_SIGNAL_NAME
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VARIABLES

Constructor Summary

Constructors

Constructor	Description
SignalBroadcastRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getSignalName()	The name of the signal to broadcast.
String	getTenantId()	The ID of the tenant that owns the signal.
Map<String,Object>	getVariables()	The signal variables as a JSON object.
int	hashCode()
SignalBroadcastRequest	putVariablesItem(String key, Object variablesItem)
void	setSignalName(String signalName)
void	setTenantId(String tenantId)
void	setVariables(Map<String,Object> variables)
SignalBroadcastRequest	signalName(String signalName)
SignalBroadcastRequest	tenantId(String tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
SignalBroadcastRequest	variables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_SIGNAL_NAME

public static final String JSON_PROPERTY_SIGNAL_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_VARIABLES

public static final String JSON_PROPERTY_VARIABLES

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

Constructor Details

SignalBroadcastRequest

public SignalBroadcastRequest()

Method Details

signalName

public SignalBroadcastRequest signalName(@Nonnull
 String signalName)

getSignalName

@Nonnull
public String getSignalName()

The name of the signal to broadcast.

Returns:

signalName

setSignalName

public void setSignalName(@Nonnull
 String signalName)

variables

public SignalBroadcastRequest variables(@Nullable
 Map<String,Object> variables)

putVariablesItem

public SignalBroadcastRequest putVariablesItem(String key,
 Object variablesItem)

getVariables

@Nullable
public Map<String,Object> getVariables()

The signal variables as a JSON object.

Returns:

variables

setVariables

public void setVariables(@Nullable
 Map<String,Object> variables)

tenantId

public SignalBroadcastRequest tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

The ID of the tenant that owns the signal.

Returns:

tenantId

setTenantId

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