Package io.camunda.client.protocol.rest

Class CorrelatedMessageSubscriptionResult

java.lang.Object

io.camunda.client.protocol.rest.CorrelatedMessageSubscriptionResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class CorrelatedMessageSubscriptionResult
extends Object

CorrelatedMessageSubscriptionResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BUSINESS_ID
static final String	JSON_PROPERTY_CORRELATION_KEY
static final String	JSON_PROPERTY_CORRELATION_TIME
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_MESSAGE_KEY
static final String	JSON_PROPERTY_MESSAGE_NAME
static final String	JSON_PROPERTY_PARTITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_SUBSCRIPTION_KEY
static final String	JSON_PROPERTY_TENANT_ID

Constructor Summary

Constructors

Constructor	Description
CorrelatedMessageSubscriptionResult()

Method Summary

Modifier and Type	Method	Description
CorrelatedMessageSubscriptionResult	businessId(String businessId)
CorrelatedMessageSubscriptionResult	correlationKey(String correlationKey)
CorrelatedMessageSubscriptionResult	correlationTime(String correlationTime)
CorrelatedMessageSubscriptionResult	elementId(String elementId)
CorrelatedMessageSubscriptionResult	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
String	getBusinessId()	The business id associated with this correlated message subscription.
String	getCorrelationKey()	The correlation key of the message.
String	getCorrelationTime()	The time when the message was correlated.
String	getElementId()	The element ID that received the message.
String	getElementInstanceKey()	The element instance key that received the message.
String	getMessageKey()	The message key.
String	getMessageName()	The name of the message.
Integer	getPartitionId()	The partition ID that correlated the message.
String	getProcessDefinitionId()	The process definition ID associated with this correlated message subscription.
String	getProcessDefinitionKey()	The process definition key associated with this correlated message subscription.
String	getProcessInstanceKey()	The process instance key associated with this correlated message subscription.
String	getRootProcessInstanceKey()	The key of the root process instance.
String	getSubscriptionKey()	The subscription key that received the message.
String	getTenantId()	The tenant ID associated with this correlated message subscription.
int	hashCode()
CorrelatedMessageSubscriptionResult	messageKey(String messageKey)
CorrelatedMessageSubscriptionResult	messageName(String messageName)
CorrelatedMessageSubscriptionResult	partitionId(Integer partitionId)
CorrelatedMessageSubscriptionResult	processDefinitionId(String processDefinitionId)
CorrelatedMessageSubscriptionResult	processDefinitionKey(String processDefinitionKey)
CorrelatedMessageSubscriptionResult	processInstanceKey(String processInstanceKey)
CorrelatedMessageSubscriptionResult	rootProcessInstanceKey(String rootProcessInstanceKey)
void	setBusinessId(String businessId)
void	setCorrelationKey(String correlationKey)
void	setCorrelationTime(String correlationTime)
void	setElementId(String elementId)
void	setElementInstanceKey(String elementInstanceKey)
void	setMessageKey(String messageKey)
void	setMessageName(String messageName)
void	setPartitionId(Integer partitionId)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setProcessInstanceKey(String processInstanceKey)
void	setRootProcessInstanceKey(String rootProcessInstanceKey)
void	setSubscriptionKey(String subscriptionKey)
void	setTenantId(String tenantId)
CorrelatedMessageSubscriptionResult	subscriptionKey(String subscriptionKey)
CorrelatedMessageSubscriptionResult	tenantId(String tenantId)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_BUSINESS_ID

public static final String JSON_PROPERTY_BUSINESS_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CORRELATION_KEY

public static final String JSON_PROPERTY_CORRELATION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_CORRELATION_TIME

public static final String JSON_PROPERTY_CORRELATION_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE_KEY

public static final String JSON_PROPERTY_MESSAGE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE_NAME

public static final String JSON_PROPERTY_MESSAGE_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_PARTITION_ID

public static final String JSON_PROPERTY_PARTITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_KEY

public static final String JSON_PROPERTY_PROCESS_DEFINITION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_ROOT_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_SUBSCRIPTION_KEY

public static final String JSON_PROPERTY_SUBSCRIPTION_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

Constructor Details

CorrelatedMessageSubscriptionResult

public CorrelatedMessageSubscriptionResult()

Method Details

businessId

public CorrelatedMessageSubscriptionResult businessId(@Nullable
 String businessId)

getBusinessId

@Nullable
public String getBusinessId()

The business id associated with this correlated message subscription. For a message start event correlation, it is the business id carried by the correlating message that was stamped on the started process instance to enforce its uniqueness. For a catch, boundary, or intermediate event correlation, it is the business id of the subscribing process instance, captured when the subscription was opened. It is `null` when the relevant process instance has no business id.

Returns:

businessId

setBusinessId

public void setBusinessId(@Nullable
 String businessId)

correlationKey

public CorrelatedMessageSubscriptionResult correlationKey(@Nullable
 String correlationKey)

getCorrelationKey

@Nullable
public String getCorrelationKey()

The correlation key of the message.

Returns:

correlationKey

setCorrelationKey

public void setCorrelationKey(@Nullable
 String correlationKey)

correlationTime

public CorrelatedMessageSubscriptionResult correlationTime(@Nonnull
 String correlationTime)

getCorrelationTime

@Nonnull
public String getCorrelationTime()

The time when the message was correlated.

Returns:

correlationTime

setCorrelationTime

public void setCorrelationTime(@Nonnull
 String correlationTime)

elementId

public CorrelatedMessageSubscriptionResult elementId(@Nonnull
 String elementId)

getElementId

@Nonnull
public String getElementId()

The element ID that received the message.

Returns:

elementId

setElementId

public void setElementId(@Nonnull
 String elementId)

elementInstanceKey

public CorrelatedMessageSubscriptionResult elementInstanceKey(@Nullable
 String elementInstanceKey)

getElementInstanceKey

@Nullable
public String getElementInstanceKey()

The element instance key that received the message. It is `null` for start event subscriptions.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 String elementInstanceKey)

messageKey

public CorrelatedMessageSubscriptionResult messageKey(@Nonnull
 String messageKey)

getMessageKey

@Nonnull
public String getMessageKey()

The message key.

Returns:

messageKey

setMessageKey

public void setMessageKey(@Nonnull
 String messageKey)

messageName

public CorrelatedMessageSubscriptionResult messageName(@Nonnull
 String messageName)

getMessageName

@Nonnull
public String getMessageName()

The name of the message.

Returns:

messageName

setMessageName

public void setMessageName(@Nonnull
 String messageName)

partitionId

public CorrelatedMessageSubscriptionResult partitionId(@Nonnull
 Integer partitionId)

getPartitionId

@Nonnull
public Integer getPartitionId()

The partition ID that correlated the message.

Returns:

partitionId

setPartitionId

public void setPartitionId(@Nonnull
 Integer partitionId)

processDefinitionId

public CorrelatedMessageSubscriptionResult processDefinitionId(@Nonnull
 String processDefinitionId)

getProcessDefinitionId

@Nonnull
public String getProcessDefinitionId()

The process definition ID associated with this correlated message subscription.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nonnull
 String processDefinitionId)

processDefinitionKey

public CorrelatedMessageSubscriptionResult processDefinitionKey(@Nonnull
 String processDefinitionKey)

getProcessDefinitionKey

@Nonnull
public String getProcessDefinitionKey()

The process definition key associated with this correlated message subscription.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nonnull
 String processDefinitionKey)

processInstanceKey

public CorrelatedMessageSubscriptionResult processInstanceKey(@Nonnull
 String processInstanceKey)

getProcessInstanceKey

@Nonnull
public String getProcessInstanceKey()

The process instance key associated with this correlated message subscription.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nonnull
 String processInstanceKey)

rootProcessInstanceKey

public CorrelatedMessageSubscriptionResult 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)

subscriptionKey

public CorrelatedMessageSubscriptionResult subscriptionKey(@Nonnull
 String subscriptionKey)

getSubscriptionKey

@Nonnull
public String getSubscriptionKey()

The subscription key that received the message.

Returns:

subscriptionKey

setSubscriptionKey

public void setSubscriptionKey(@Nonnull
 String subscriptionKey)

tenantId

public CorrelatedMessageSubscriptionResult tenantId(@Nonnull
 String tenantId)

getTenantId

@Nonnull
public String getTenantId()

The tenant ID associated with this correlated message subscription.

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