Package io.camunda.client.protocol.rest

Class PartitionBackupInfo

java.lang.Object

io.camunda.client.protocol.rest.PartitionBackupInfo

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

Detailed info of the backup for a given partition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BROKER_ID
static final String	JSON_PROPERTY_BROKER_VERSION
static final String	JSON_PROPERTY_CHECKPOINT_POSITION
static final String	JSON_PROPERTY_CREATED_AT
static final String	JSON_PROPERTY_FAILURE_REASON
static final String	JSON_PROPERTY_FIRST_LOG_POSITION
static final String	JSON_PROPERTY_LAST_UPDATED_AT
static final String	JSON_PROPERTY_PARTITION_ID
static final String	JSON_PROPERTY_SNAPSHOT_ID
static final String	JSON_PROPERTY_STATE

Constructor Summary

Constructors

Constructor	Description
PartitionBackupInfo()
PartitionBackupInfo(Integer partitionId, StateCode state, String createdAt, String lastUpdatedAt, String snapshotId, Long firstLogPosition, Long checkpointPosition, Integer brokerId, String brokerVersion)	Constructor with only readonly parameters

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
PartitionBackupInfo	failureReason(String failureReason)
Integer	getBrokerId()	The id of the broker from which the backup was taken for this partition.
String	getBrokerVersion()	The version of the broker from which the backup was taken for this partition.
Long	getCheckpointPosition()	The position of the checkpoint for this backup.
String	getCreatedAt()	The timestamp at which the backup was started on this partition.
String	getFailureReason()	Failure reason if the state is 'FAILED'.
Long	getFirstLogPosition()	The first log position included in this backup.
String	getLastUpdatedAt()	The timestamp at which the backup was last updated on this partition, e.g. changed state from 'IN_PROGRESS' to 'COMPLETED'.
Integer	getPartitionId()	The id of the partition.
String	getSnapshotId()	The id of the snapshot which is included in this backup.
StateCode	getState()	The state of the backup on this partition.
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_PARTITION_ID

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

public static final String JSON_PROPERTY_CREATED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_LAST_UPDATED_AT

public static final String JSON_PROPERTY_LAST_UPDATED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_SNAPSHOT_ID

public static final String JSON_PROPERTY_SNAPSHOT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_FIRST_LOG_POSITION

public static final String JSON_PROPERTY_FIRST_LOG_POSITION

See Also:

• Constant Field Values

JSON_PROPERTY_CHECKPOINT_POSITION

public static final String JSON_PROPERTY_CHECKPOINT_POSITION

See Also:

• Constant Field Values

JSON_PROPERTY_BROKER_ID

public static final String JSON_PROPERTY_BROKER_ID

See Also:

• Constant Field Values

JSON_PROPERTY_BROKER_VERSION

public static final String JSON_PROPERTY_BROKER_VERSION

See Also:

• Constant Field Values

Constructor Details

PartitionBackupInfo

public PartitionBackupInfo()

PartitionBackupInfo

public PartitionBackupInfo(Integer partitionId,
 StateCode state,
 String createdAt,
 String lastUpdatedAt,
 String snapshotId,
 Long firstLogPosition,
 Long checkpointPosition,
 Integer brokerId,
 String brokerVersion)

Constructor with only readonly parameters

Method Details

getPartitionId

@Nonnull
public Integer getPartitionId()

The id of the partition. minimum: 1

Returns:

partitionId

getState

@Nonnull
public StateCode getState()

The state of the backup on this partition.

Returns:

state

failureReason

public PartitionBackupInfo failureReason(@Nullable
 String failureReason)

getFailureReason

@Nullable
public String getFailureReason()

Failure reason if the state is 'FAILED'.

Returns:

failureReason

setFailureReason

public void setFailureReason(@Nullable
 String failureReason)

getCreatedAt

@Nullable
public String getCreatedAt()

The timestamp at which the backup was started on this partition.

Returns:

createdAt

getLastUpdatedAt

@Nullable
public String getLastUpdatedAt()

The timestamp at which the backup was last updated on this partition, e.g. changed state from 'IN_PROGRESS' to 'COMPLETED'.

Returns:

lastUpdatedAt

getSnapshotId

@Nullable
public String getSnapshotId()

The id of the snapshot which is included in this backup.

Returns:

snapshotId

getFirstLogPosition

@Nullable
public Long getFirstLogPosition()

The first log position included in this backup.

Returns:

firstLogPosition

getCheckpointPosition

@Nullable
public Long getCheckpointPosition()

The position of the checkpoint for this backup.

Returns:

checkpointPosition

getBrokerId

@Nullable
public Integer getBrokerId()

The id of the broker from which the backup was taken for this partition. minimum: 0

Returns:

brokerId

getBrokerVersion

@Nullable
public String getBrokerVersion()

The version of the broker from which the backup was taken for this partition.

Returns:

brokerVersion

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