Package io.fluxcapacitor.common.api.search

Class BulkUpdateDocuments

java.lang.Object

io.fluxcapacitor.common.api.Request

io.fluxcapacitor.common.api.Command

io.fluxcapacitor.common.api.search.BulkUpdateDocuments

All Implemented Interfaces:

JsonType

public class BulkUpdateDocuments
extends Command

Command to perform a batch update of documents in the search/document store.

This operation accepts a collection of DocumentUpdate items, which may be of the types:

• IndexDocument – index or replace a document
• IndexDocumentIfNotExists – index only if the document does not yet exist
• DeleteDocument – remove a document from a collection

The entire batch is processed together, and depending on the Guarantee, may ensure delivery or persistence.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkUpdateDocuments.Metric	Metric representation for monitoring or observability.

Constructor Summary

Constructors

Constructor	Description
BulkUpdateDocuments()

Method Summary

Modifier and Type	Method	Description
int	getSize()
String	routingKey()	Uses the ID of the first update as the routing key for this command.
Object	toMetric()	Metric representation of the bulk update, for logging or monitoring.
String	toString()

Methods inherited from class io.fluxcapacitor.common.api.Command

getGuarantee

Methods inherited from class java.lang.Object

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

Constructor Details

BulkUpdateDocuments

public BulkUpdateDocuments()

Method Details

getSize

public int getSize()

Returns:

the number of document updates in this batch.

toString

public String toString()

Overrides:

toString in class Object

toMetric

public Object toMetric()

Metric representation of the bulk update, for logging or monitoring.

Returns:

a safe and compact object suitable for serialization to the metrics log

routingKey

public String routingKey()

Uses the ID of the first update as the routing key for this command.

Overrides:

routingKey in class Command

Returns:

a routing key string, or null if not specified