Package io.camunda.zeebe.gateway.admin.backup

Record Class BackupStatus

java.lang.Object

java.lang.Record

io.camunda.zeebe.gateway.admin.backup.BackupStatus

Record Components:

backupId - id of the backup

status - aggregated status of backup

failureReason - If the status == FAILED, then provides a reason for failure

partitions - status of backup of all partitions

public record BackupStatus(long backupId, State status, Optional<String> failureReason, List<PartitionBackupStatus> partitions)
extends Record

Shows the aggregated status of the backup and status of backup of each partition.

Aggregates status is calculated as follows:

COMPLETED => If all partitions have completed backup

FAILED => If backup of atleast one partition is failed

DOES_NOT_EXIST => If backup of atleast one partition does not exist.

IN_PROGRESS => Otherwise

Constructor Summary

Constructors

Constructor	Description
BackupStatus(long backupId, State status, Optional<String> failureReason, List<PartitionBackupStatus> partitions)	Creates an instance of a BackupStatus record class.

Method Summary

Modifier and Type	Method	Description
long	backupId()	Returns the value of the backupId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<String>	failureReason()	Returns the value of the failureReason record component.
final int	hashCode()	Returns a hash code value for this object.
List<PartitionBackupStatus>	partitions()	Returns the value of the partitions record component.
State	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

BackupStatus

public BackupStatus(long backupId,
 State status,
 Optional<String> failureReason,
 List<PartitionBackupStatus> partitions)

Creates an instance of a BackupStatus record class.

Parameters:

backupId - the value for the backupId record component

status - the value for the status record component

failureReason - the value for the failureReason record component

partitions - the value for the partitions record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

backupId

public long backupId()

Returns the value of the backupId record component.

Returns:

the value of the backupId record component

status

public State status()

Returns the value of the status record component.

Returns:

the value of the status record component

failureReason

public Optional<String> failureReason()

Returns the value of the failureReason record component.

Returns:

the value of the failureReason record component

partitions

public List<PartitionBackupStatus> partitions()

Returns the value of the partitions record component.

Returns:

the value of the partitions record component