Package io.camunda.client.protocol.rest

Class ProcessDefinitionFilter

java.lang.Object

io.camunda.client.protocol.rest.ProcessDefinitionFilter

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

Process definition search filter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_HAS_START_FORM
static final String	JSON_PROPERTY_IS_LATEST_VERSION
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_DEFINITION_KEY
static final String	JSON_PROPERTY_RESOURCE_NAME
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_VERSION
static final String	JSON_PROPERTY_VERSION_TAG

Constructor Summary

Constructors

Constructor	Description
ProcessDefinitionFilter()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Boolean	getHasStartForm()	Indicates whether the start event of the process has an associated Form Key.
Boolean	getIsLatestVersion()	Whether to only return the latest version of each process definition.
StringFilterProperty	getName()	Name of this process definition.
StringFilterProperty	getProcessDefinitionId()	Process definition ID of this process definition.
String	getProcessDefinitionKey()	The key for this process definition.
String	getResourceName()	Resource name of this process definition.
String	getTenantId()	Tenant ID of this process definition.
Integer	getVersion()	Version of this process definition.
String	getVersionTag()	Version tag of this process definition.
int	hashCode()
ProcessDefinitionFilter	hasStartForm(Boolean hasStartForm)
ProcessDefinitionFilter	isLatestVersion(Boolean isLatestVersion)
ProcessDefinitionFilter	name(StringFilterProperty name)
ProcessDefinitionFilter	processDefinitionId(StringFilterProperty processDefinitionId)
ProcessDefinitionFilter	processDefinitionKey(String processDefinitionKey)
ProcessDefinitionFilter	resourceName(String resourceName)
void	setHasStartForm(Boolean hasStartForm)
void	setIsLatestVersion(Boolean isLatestVersion)
void	setName(StringFilterProperty name)
void	setProcessDefinitionId(StringFilterProperty processDefinitionId)
void	setProcessDefinitionKey(String processDefinitionKey)
void	setResourceName(String resourceName)
void	setTenantId(String tenantId)
void	setVersion(Integer version)
void	setVersionTag(String versionTag)
ProcessDefinitionFilter	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.
ProcessDefinitionFilter	version(Integer version)
ProcessDefinitionFilter	versionTag(String versionTag)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_IS_LATEST_VERSION

public static final String JSON_PROPERTY_IS_LATEST_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_RESOURCE_NAME

public static final String JSON_PROPERTY_RESOURCE_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_VERSION

public static final String JSON_PROPERTY_VERSION

See Also:

• Constant Field Values

JSON_PROPERTY_VERSION_TAG

public static final String JSON_PROPERTY_VERSION_TAG

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_TENANT_ID

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

public static final String JSON_PROPERTY_HAS_START_FORM

See Also:

• Constant Field Values

Constructor Details

ProcessDefinitionFilter

public ProcessDefinitionFilter()

Method Details

name

public ProcessDefinitionFilter name(@Nullable
 StringFilterProperty name)

getName

@Nullable
public StringFilterProperty getName()

Name of this process definition.

Returns:

name

setName

public void setName(@Nullable
 StringFilterProperty name)

isLatestVersion

public ProcessDefinitionFilter isLatestVersion(@Nullable
 Boolean isLatestVersion)

getIsLatestVersion

@Nullable
public Boolean getIsLatestVersion()

Whether to only return the latest version of each process definition. When using this filter, pagination functionality is limited, you can only paginate forward using `after` and `limit`. The response contains no `startCursor` in the `page`, and requests ignore the `from` and `before` in the `page`.

Returns:

isLatestVersion

setIsLatestVersion

public void setIsLatestVersion(@Nullable
 Boolean isLatestVersion)

resourceName

public ProcessDefinitionFilter resourceName(@Nullable
 String resourceName)

getResourceName

@Nullable
public String getResourceName()

Resource name of this process definition.

Returns:

resourceName

setResourceName

public void setResourceName(@Nullable
 String resourceName)

version

public ProcessDefinitionFilter version(@Nullable
 Integer version)

getVersion

@Nullable
public Integer getVersion()

Version of this process definition.

Returns:

version

setVersion

public void setVersion(@Nullable
 Integer version)

versionTag

public ProcessDefinitionFilter versionTag(@Nullable
 String versionTag)

getVersionTag

@Nullable
public String getVersionTag()

Version tag of this process definition.

Returns:

versionTag

setVersionTag

public void setVersionTag(@Nullable
 String versionTag)

processDefinitionId

public ProcessDefinitionFilter processDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

getProcessDefinitionId

@Nullable
public StringFilterProperty getProcessDefinitionId()

Process definition ID of this process definition.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 StringFilterProperty processDefinitionId)

tenantId

public ProcessDefinitionFilter tenantId(@Nullable
 String tenantId)

getTenantId

@Nullable
public String getTenantId()

Tenant ID of this process definition.

Returns:

tenantId

setTenantId

public void setTenantId(@Nullable
 String tenantId)

processDefinitionKey

public ProcessDefinitionFilter processDefinitionKey(@Nullable
 String processDefinitionKey)

getProcessDefinitionKey

@Nullable
public String getProcessDefinitionKey()

The key for this process definition.

Returns:

processDefinitionKey

setProcessDefinitionKey

public void setProcessDefinitionKey(@Nullable
 String processDefinitionKey)

hasStartForm

public ProcessDefinitionFilter hasStartForm(@Nullable
 Boolean hasStartForm)

getHasStartForm

@Nullable
public Boolean getHasStartForm()

Indicates whether the start event of the process has an associated Form Key.

Returns:

hasStartForm

setHasStartForm

public void setHasStartForm(@Nullable
 Boolean hasStartForm)

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