Package io.camunda.client.protocol.rest

Class Partition

java.lang.Object

io.camunda.client.protocol.rest.Partition

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

Provides information on a partition within a broker node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Partition.HealthEnum	Describes the current health of the partition.
static enum	Partition.RoleEnum	Describes the Raft role of the broker for a given partition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_HEALTH
static final String	JSON_PROPERTY_PARTITION_ID
static final String	JSON_PROPERTY_ROLE

Constructor Summary

Constructors

Constructor	Description
Partition()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Partition.HealthEnum	getHealth()	Describes the current health of the partition.
Integer	getPartitionId()	The unique ID of this partition.
Partition.RoleEnum	getRole()	Describes the Raft role of the broker for a given partition.
int	hashCode()
Partition	health(Partition.HealthEnum health)
Partition	partitionId(Integer partitionId)
Partition	role(Partition.RoleEnum role)
void	setHealth(Partition.HealthEnum health)
void	setPartitionId(Integer partitionId)
void	setRole(Partition.RoleEnum role)
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_PARTITION_ID

public static final String JSON_PROPERTY_PARTITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ROLE

public static final String JSON_PROPERTY_ROLE

See Also:

• Constant Field Values

JSON_PROPERTY_HEALTH

public static final String JSON_PROPERTY_HEALTH

See Also:

• Constant Field Values

Constructor Details

Partition

public Partition()

Method Details

partitionId

public Partition partitionId(@Nullable
 Integer partitionId)

getPartitionId

@Nullable
public Integer getPartitionId()

The unique ID of this partition.

Returns:

partitionId

setPartitionId

public void setPartitionId(@Nullable
 Integer partitionId)

role

public Partition role(@Nullable
 Partition.RoleEnum role)

getRole

@Nullable
public Partition.RoleEnum getRole()

Describes the Raft role of the broker for a given partition.

Returns:

role

setRole

public void setRole(@Nullable
 Partition.RoleEnum role)

health

public Partition health(@Nullable
 Partition.HealthEnum health)

getHealth

@Nullable
public Partition.HealthEnum getHealth()

Describes the current health of the partition.

Returns:

health

setHealth

public void setHealth(@Nullable
 Partition.HealthEnum health)

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