Package io.camunda.client.protocol.rest

Class MessageSubscriptionFilter

java.lang.Object

io.camunda.client.protocol.rest.MessageSubscriptionFilter

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

Message subscription search filter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CORRELATION_KEY
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_LAST_UPDATED_DATE
static final String	JSON_PROPERTY_MESSAGE_NAME
static final String	JSON_PROPERTY_MESSAGE_SUBSCRIPTION_KEY
static final String	JSON_PROPERTY_MESSAGE_SUBSCRIPTION_STATE
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_TENANT_ID

Constructor Summary

Constructors

Constructor	Description
MessageSubscriptionFilter()

Method Summary

Modifier and Type	Method	Description
MessageSubscriptionFilter	correlationKey(StringFilterProperty correlationKey)
MessageSubscriptionFilter	elementId(StringFilterProperty elementId)
MessageSubscriptionFilter	elementInstanceKey(BasicStringFilterProperty elementInstanceKey)
boolean	equals(Object o)
StringFilterProperty	getCorrelationKey()	The correlation key of the message subscription.
StringFilterProperty	getElementId()	The element ID associated with this message subscription.
BasicStringFilterProperty	getElementInstanceKey()	The element instance key associated with this message subscription.
DateTimeFilterProperty	getLastUpdatedDate()	The last updated date of the message subscription.
StringFilterProperty	getMessageName()	The name of the message associated with the message subscription.
BasicStringFilterProperty	getMessageSubscriptionKey()	The message subscription key associated with this message subscription.
MessageSubscriptionStateFilterProperty	getMessageSubscriptionState()	The message subscription state.
StringFilterProperty	getProcessDefinitionId()	The process definition ID associated with this message subscription.
BasicStringFilterProperty	getProcessInstanceKey()	The process instance key associated with this message subscription.
StringFilterProperty	getTenantId()	The unique external tenant ID.
int	hashCode()
MessageSubscriptionFilter	lastUpdatedDate(DateTimeFilterProperty lastUpdatedDate)
MessageSubscriptionFilter	messageName(StringFilterProperty messageName)
MessageSubscriptionFilter	messageSubscriptionKey(BasicStringFilterProperty messageSubscriptionKey)
MessageSubscriptionFilter	messageSubscriptionState(MessageSubscriptionStateFilterProperty messageSubscriptionState)
MessageSubscriptionFilter	processDefinitionId(StringFilterProperty processDefinitionId)
MessageSubscriptionFilter	processInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setCorrelationKey(StringFilterProperty correlationKey)
void	setElementId(StringFilterProperty elementId)
void	setElementInstanceKey(BasicStringFilterProperty elementInstanceKey)
void	setLastUpdatedDate(DateTimeFilterProperty lastUpdatedDate)
void	setMessageName(StringFilterProperty messageName)
void	setMessageSubscriptionKey(BasicStringFilterProperty messageSubscriptionKey)
void	setMessageSubscriptionState(MessageSubscriptionStateFilterProperty messageSubscriptionState)
void	setProcessDefinitionId(StringFilterProperty processDefinitionId)
void	setProcessInstanceKey(BasicStringFilterProperty processInstanceKey)
void	setTenantId(StringFilterProperty tenantId)
MessageSubscriptionFilter	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_MESSAGE_SUBSCRIPTION_KEY

public static final String JSON_PROPERTY_MESSAGE_SUBSCRIPTION_KEY

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_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

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_SUBSCRIPTION_STATE

public static final String JSON_PROPERTY_MESSAGE_SUBSCRIPTION_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_LAST_UPDATED_DATE

public static final String JSON_PROPERTY_LAST_UPDATED_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_MESSAGE_NAME

public static final String JSON_PROPERTY_MESSAGE_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_CORRELATION_KEY

public static final String JSON_PROPERTY_CORRELATION_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

MessageSubscriptionFilter

public MessageSubscriptionFilter()

Method Details

messageSubscriptionKey

public MessageSubscriptionFilter messageSubscriptionKey(@Nullable
 BasicStringFilterProperty messageSubscriptionKey)

getMessageSubscriptionKey

@Nullable
public BasicStringFilterProperty getMessageSubscriptionKey()

The message subscription key associated with this message subscription.

Returns:

messageSubscriptionKey

setMessageSubscriptionKey

public void setMessageSubscriptionKey(@Nullable
 BasicStringFilterProperty messageSubscriptionKey)

processDefinitionId

public MessageSubscriptionFilter processDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

getProcessDefinitionId

@Nullable
public StringFilterProperty getProcessDefinitionId()

The process definition ID associated with this message subscription.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

processInstanceKey

public MessageSubscriptionFilter processInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

getProcessInstanceKey

@Nullable
public BasicStringFilterProperty getProcessInstanceKey()

The process instance key associated with this message subscription.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 BasicStringFilterProperty processInstanceKey)

elementId

public MessageSubscriptionFilter elementId(@Nullable
 StringFilterProperty elementId)

getElementId

@Nullable
public StringFilterProperty getElementId()

The element ID associated with this message subscription.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 StringFilterProperty elementId)

elementInstanceKey

public MessageSubscriptionFilter elementInstanceKey(@Nullable
 BasicStringFilterProperty elementInstanceKey)

getElementInstanceKey

@Nullable
public BasicStringFilterProperty getElementInstanceKey()

The element instance key associated with this message subscription.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nullable
 BasicStringFilterProperty elementInstanceKey)

messageSubscriptionState

public MessageSubscriptionFilter messageSubscriptionState(@Nullable
 MessageSubscriptionStateFilterProperty messageSubscriptionState)

getMessageSubscriptionState

@Nullable
public MessageSubscriptionStateFilterProperty getMessageSubscriptionState()

The message subscription state.

Returns:

messageSubscriptionState

setMessageSubscriptionState

public void setMessageSubscriptionState(@Nullable
 MessageSubscriptionStateFilterProperty messageSubscriptionState)

lastUpdatedDate

public MessageSubscriptionFilter lastUpdatedDate(@Nullable
 DateTimeFilterProperty lastUpdatedDate)

getLastUpdatedDate

@Nullable
public DateTimeFilterProperty getLastUpdatedDate()

The last updated date of the message subscription.

Returns:

lastUpdatedDate

setLastUpdatedDate

public void setLastUpdatedDate(@Nullable
 DateTimeFilterProperty lastUpdatedDate)

messageName

public MessageSubscriptionFilter messageName(@Nullable
 StringFilterProperty messageName)

getMessageName

@Nullable
public StringFilterProperty getMessageName()

The name of the message associated with the message subscription.

Returns:

messageName

setMessageName

public void setMessageName(@Nullable
 StringFilterProperty messageName)

correlationKey

public MessageSubscriptionFilter correlationKey(@Nullable
 StringFilterProperty correlationKey)

getCorrelationKey

@Nullable
public StringFilterProperty getCorrelationKey()

The correlation key of the message subscription.

Returns:

correlationKey

setCorrelationKey

public void setCorrelationKey(@Nullable
 StringFilterProperty correlationKey)

tenantId

public MessageSubscriptionFilter tenantId(@Nullable
 StringFilterProperty tenantId)

getTenantId

@Nullable
public StringFilterProperty getTenantId()

The unique external tenant ID.

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