Package io.camunda.client.protocol.rest

Class BackupInfo

java.lang.Object

io.camunda.client.protocol.rest.BackupInfo

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class BackupInfo
extends Object

Detailed status of a runtime backup. The aggregated state is computed from the backup state of each partition as: - If the backup of all partitions is 'COMPLETED', the overall state is 'COMPLETED'. - If one partition is 'FAILED', the overall state is 'FAILED'. - Otherwise, if one partition is 'DOES_NOT_EXIST', the overall state is 'INCOMPLETE'. - Otherwise, if one partition is 'IN_PROGRESS', the overall state is 'IN_PROGRESS'.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BACKUP_ID
static final String	JSON_PROPERTY_DETAILS
static final String	JSON_PROPERTY_FAILURE_REASON
static final String	JSON_PROPERTY_STATE

Constructor Summary

Constructors

Constructor	Description
BackupInfo()
BackupInfo(Long backupId, StateCode state, List<PartitionBackupInfo> details)	Constructor with only readonly parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BackupInfo	failureReason(String failureReason)
Long	getBackupId()	The id of the backup.
List<PartitionBackupInfo>	getDetails()	Detailed status of the backup per partition.
String	getFailureReason()	Reason for failure if the state is 'FAILED'.
StateCode	getState()	The aggregated state of the backup.
int	hashCode()
void	setFailureReason(String failureReason)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_BACKUP_ID

public static final String JSON_PROPERTY_BACKUP_ID

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

public static final String JSON_PROPERTY_STATE

See Also:

• Constant Field Values

JSON_PROPERTY_FAILURE_REASON

public static final String JSON_PROPERTY_FAILURE_REASON

See Also:

• Constant Field Values

JSON_PROPERTY_DETAILS

public static final String JSON_PROPERTY_DETAILS

See Also:

• Constant Field Values

Constructor Details

BackupInfo

public BackupInfo()

BackupInfo

public BackupInfo(Long backupId,
 StateCode state,
 List<PartitionBackupInfo> details)

Constructor with only readonly parameters

Method Details

getBackupId

@Nonnull
public Long getBackupId()

The id of the backup. minimum: 1

Returns:

backupId

getState

@Nonnull
public StateCode getState()

The aggregated state of the backup.

Returns:

state

failureReason

public BackupInfo failureReason(@Nullable
 String failureReason)

getFailureReason

@Nullable
public String getFailureReason()

Reason for failure if the state is 'FAILED'.

Returns:

failureReason

setFailureReason

public void setFailureReason(@Nullable
 String failureReason)

getDetails

@Nonnull
public List<PartitionBackupInfo> getDetails()

Detailed status of the backup per partition. Always contains every partition of the physical tenant.

Returns:

details

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