Package io.camunda.client.protocol.rest

Class CorrelatedMessageSubscriptionFilter

java.lang.Object

io.camunda.client.protocol.rest.CorrelatedMessageSubscriptionFilter

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class CorrelatedMessageSubscriptionFilter
extends Object

Correlated message subscriptions search filter.

Field Summary

Fields

Modifier and Type	Field	Description
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_SUBSCRIPTION_KEY
static final String	JSON_PROPERTY_TENANT_ID

Constructor Summary

Constructors

Constructor	Description
CorrelatedMessageSubscriptionFilter()

Method Summary

Modifier and Type	Method	Description
CorrelatedMessageSubscriptionFilter	correlationKey(StringFilterProperty correlationKey)
CorrelatedMessageSubscriptionFilter	correlationTime(DateTimeFilterProperty correlationTime)
CorrelatedMessageSubscriptionFilter	elementId(StringFilterProperty elementId)
CorrelatedMessageSubscriptionFilter	elementInstanceKey(BasicStringFilterProperty elementInstanceKey)
boolean	equals(Object o)
StringFilterProperty	getCorrelationKey()	The correlation key of the message.
DateTimeFilterProperty	getCorrelationTime()	The time when the message was correlated.
StringFilterProperty	getElementId()	The element ID that received the message.
BasicStringFilterProperty	getElementInstanceKey()	The element instance key that received the message.
BasicStringFilterProperty	getMessageKey()	The message key.
StringFilterProperty	getMessageName()	The name of the message.
IntegerFilterProperty	getPartitionId()	The partition ID that correlated the message.
StringFilterProperty	getProcessDefinitionId()	The process definition ID associated with this correlated message subscription.
BasicStringFilterProperty	getProcessDefinitionKey()	The process definition key associated with this correlated message subscription.
BasicStringFilterProperty	getProcessInstanceKey()	The process instance key associated with this correlated message subscription.
BasicStringFilterProperty	getSubscriptionKey()	The subscription key that received the message.
StringFilterProperty	getTenantId()	The tenant ID associated with this correlated message subscription.
int	hashCode()
CorrelatedMessageSubscriptionFilter	messageKey(BasicStringFilterProperty messageKey)
CorrelatedMessageSubscriptionFilter	messageName(StringFilterProperty messageName)
CorrelatedMessageSubscriptionFilter	partitionId(IntegerFilterProperty partitionId)
CorrelatedMessageSubscriptionFilter	processDefinitionId(StringFilterProperty processDefinitionId)
CorrelatedMessageSubscriptionFilter	processDefinitionKey(BasicStringFilterProperty processDefinitionKey)
CorrelatedMessageSubscriptionFilter	processInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setCorrelationKey(StringFilterProperty correlationKey)
void	setCorrelationTime(DateTimeFilterProperty correlationTime)
void	setElementId(StringFilterProperty elementId)
void	setElementInstanceKey(BasicStringFilterProperty elementInstanceKey)
void	setMessageKey(BasicStringFilterProperty messageKey)
void	setMessageName(StringFilterProperty messageName)
void	setPartitionId(IntegerFilterProperty partitionId)
void	setProcessDefinitionId(StringFilterProperty processDefinitionId)
void	setProcessDefinitionKey(BasicStringFilterProperty processDefinitionKey)
void	setProcessInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setSubscriptionKey(BasicStringFilterProperty subscriptionKey)
void	setTenantId(StringFilterProperty tenantId)
CorrelatedMessageSubscriptionFilter	subscriptionKey(BasicStringFilterProperty subscriptionKey)
CorrelatedMessageSubscriptionFilter	tenantId(StringFilterProperty tenantId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

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

Field Details

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_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

CorrelatedMessageSubscriptionFilter

public CorrelatedMessageSubscriptionFilter()

Method Details

correlationKey

public CorrelatedMessageSubscriptionFilter correlationKey(@Nullable
 StringFilterProperty correlationKey)

getCorrelationKey

@Nullable
public StringFilterProperty getCorrelationKey()

The correlation key of the message.

Returns:

correlationKey

setCorrelationKey

public void setCorrelationKey(@Nullable
 StringFilterProperty correlationKey)

correlationTime

public CorrelatedMessageSubscriptionFilter correlationTime(@Nullable
 DateTimeFilterProperty correlationTime)

getCorrelationTime

@Nullable
public DateTimeFilterProperty getCorrelationTime()

The time when the message was correlated.

Returns:

correlationTime

setCorrelationTime

public void setCorrelationTime(@Nullable
 DateTimeFilterProperty correlationTime)

elementId

public CorrelatedMessageSubscriptionFilter elementId(@Nullable
 StringFilterProperty elementId)

getElementId

@Nullable
public StringFilterProperty getElementId()

The element ID that received the message.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 StringFilterProperty elementId)

elementInstanceKey

public CorrelatedMessageSubscriptionFilter elementInstanceKey(@Nullable
 BasicStringFilterProperty elementInstanceKey)

getElementInstanceKey

@Nullable
public BasicStringFilterProperty getElementInstanceKey()

The element instance key that received the message.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 BasicStringFilterProperty elementInstanceKey)

messageKey

public CorrelatedMessageSubscriptionFilter messageKey(@Nullable
 BasicStringFilterProperty messageKey)

getMessageKey

@Nullable
public BasicStringFilterProperty getMessageKey()

The message key.

Returns:

messageKey

setMessageKey

public void setMessageKey(@Nullable
 BasicStringFilterProperty messageKey)

messageName

public CorrelatedMessageSubscriptionFilter messageName(@Nullable
 StringFilterProperty messageName)

getMessageName

@Nullable
public StringFilterProperty getMessageName()

The name of the message.

Returns:

messageName

setMessageName

public void setMessageName(@Nullable
 StringFilterProperty messageName)

partitionId

public CorrelatedMessageSubscriptionFilter partitionId(@Nullable
 IntegerFilterProperty partitionId)

getPartitionId

@Nullable
public IntegerFilterProperty getPartitionId()

The partition ID that correlated the message.

Returns:

partitionId

setPartitionId

public void setPartitionId(@Nullable
 IntegerFilterProperty partitionId)

processDefinitionId

public CorrelatedMessageSubscriptionFilter processDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

getProcessDefinitionId

@Nullable
public StringFilterProperty getProcessDefinitionId()

The process definition ID associated with this correlated message subscription.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

processDefinitionKey

public CorrelatedMessageSubscriptionFilter processDefinitionKey(@Nullable
 BasicStringFilterProperty processDefinitionKey)

getProcessDefinitionKey

@Nullable
public BasicStringFilterProperty getProcessDefinitionKey()

The process definition key associated with this correlated message subscription.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 BasicStringFilterProperty processDefinitionKey)

processInstanceKey

public CorrelatedMessageSubscriptionFilter processInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

getProcessInstanceKey

@Nullable
public BasicStringFilterProperty getProcessInstanceKey()

The process instance key associated with this correlated message subscription.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

subscriptionKey

public CorrelatedMessageSubscriptionFilter subscriptionKey(@Nullable
 BasicStringFilterProperty subscriptionKey)

getSubscriptionKey

@Nullable
public BasicStringFilterProperty getSubscriptionKey()

The subscription key that received the message.

Returns:

subscriptionKey

setSubscriptionKey

public void setSubscriptionKey(@Nullable
 BasicStringFilterProperty subscriptionKey)

tenantId

public CorrelatedMessageSubscriptionFilter tenantId(@Nullable
 StringFilterProperty tenantId)

getTenantId

@Nullable
public StringFilterProperty getTenantId()

The tenant ID associated with this correlated message subscription.

Returns:

tenantId

setTenantId

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