com.couchbase.transactions.log

Class TransactionCleanupStartRunEvent

java.lang.Object

com.couchbase.client.core.cnc.AbstractEvent

com.couchbase.transactions.log.TransactionEvent

com.couchbase.transactions.log.TransactionCleanupStartRunEvent

All Implemented Interfaces:

com.couchbase.client.core.cnc.Event

@Stability.Volatile
public class TransactionCleanupStartRunEvent
extends TransactionEvent

Emitted periodically with a summary of what will be done soon for cleanup.

As this exposes implementation details of transactions, all methods are subject to change and marked with @Stability.Volatile.

Nested Class Summary

Nested classes/interfaces inherited from interface com.couchbase.client.core.cnc.Event

com.couchbase.client.core.cnc.Event.Category, com.couchbase.client.core.cnc.Event.Severity

Field Summary

Fields inherited from interface com.couchbase.client.core.cnc.Event

CATEGORY_PREFIX

Constructor Summary

Constructors

Constructor and Description
TransactionCleanupStartRunEvent(java.lang.String bucketName, java.lang.String collectionName, java.lang.String clientUuid, ClientRecordDetails clientDetails, java.time.Duration cleanupWindow, int atrsToCheckInNextWindow, int totalAtrs, java.time.Duration checkAtrEvery)

Method Summary

Modifier and Type	Method and Description
int	atrsToCheckInNextWindow() How many ATRs this client will check over the next cleanupWindow.
java.lang.String	bucketName() The bucket containing the ATRs being checked by this cleanup.
java.time.Duration	checkAtrEvery() How regular an ATR should be checked by this client over the next cleanupWindow.
java.time.Duration	cleanupWindow() All ATRs are checked once every cleanupWindow.
int	clientIndex() The numeric index of the client in a sorted list of active clients.
java.lang.String	clientUuid() The unique ID of the this client (application).
java.lang.String	collectionName() The collection containing the ATRs being checked by this cleanup.
java.lang.String	description()
boolean	success() Provided so the app check if this event is regarded as a success, and if not, output any logs it has.
int	totalActiveClients() The total active, alive clients taking part in cleanup, including this one.
int	totalAtrs() The total number of ATRs being checked by all clients.

Methods inherited from class com.couchbase.transactions.log.TransactionEvent

logs

Methods inherited from class com.couchbase.client.core.cnc.AbstractEvent

category, context, createdAt, duration, severity, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.couchbase.client.core.cnc.Event

cause

Constructor Detail

TransactionCleanupStartRunEvent

@Stability.Volatile
public TransactionCleanupStartRunEvent(java.lang.String bucketName,
                                                           java.lang.String collectionName,
                                                           java.lang.String clientUuid,
                                                           ClientRecordDetails clientDetails,
                                                           java.time.Duration cleanupWindow,
                                                           int atrsToCheckInNextWindow,
                                                           int totalAtrs,
                                                           java.time.Duration checkAtrEvery)

Method Detail

clientIndex

@Stability.Volatile
public int clientIndex()

The numeric index of the client in a sorted list of active clients.

totalActiveClients

@Stability.Volatile
public int totalActiveClients()

The total active, alive clients taking part in cleanup, including this one.

cleanupWindow

@Stability.Volatile
public java.time.Duration cleanupWindow()

All ATRs are checked once every cleanupWindow.

atrsToCheckInNextWindow

@Stability.Volatile
public int atrsToCheckInNextWindow()

How many ATRs this client will check over the next cleanupWindow.

totalAtrs

@Stability.Volatile
public int totalAtrs()

The total number of ATRs being checked by all clients.

checkAtrEvery

@Stability.Volatile
public java.time.Duration checkAtrEvery()

How regular an ATR should be checked by this client over the next cleanupWindow.

bucketName

@Stability.Volatile
public java.lang.String bucketName()

The bucket containing the ATRs being checked by this cleanup.

collectionName

@Stability.Volatile
public java.lang.String collectionName()

The collection containing the ATRs being checked by this cleanup.

clientUuid

@Stability.Volatile
public java.lang.String clientUuid()

The unique ID of the this client (application).

description

public java.lang.String description()

success

public boolean success()

Description copied from class: TransactionEvent

Provided so the app check if this event is regarded as a success, and if not, output any logs it has.

Specified by:

success in class TransactionEvent