Package com.azure.cosmos.models

Class ChangeFeedProcessorItem

java.lang.Object

com.azure.cosmos.models.ChangeFeedProcessorItem

@Beta(value=V4_37_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public final class ChangeFeedProcessorItem
extends Object

Change Feed processor item. Supports current and previous items through JsonNode structure. Caller is recommended to type cast JsonNode to cosmos item structure.

Constructor Summary

Constructors

Constructor	Description
ChangeFeedProcessorItem()

Method Summary

Modifier and Type	Method	Description
ChangeFeedMetaData	getChangeFeedMetaData()	Gets the change feed metadata.
JsonNode	getCurrent()	Gets the change feed current item.
JsonNode	getPrevious()	Gets the change feed previous item.
JsonNode	toJsonNode()	Helper API to convert this changeFeedProcessorItem instance to raw JsonNode format.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChangeFeedProcessorItem

public ChangeFeedProcessorItem()

Method Details

getCurrent

@Beta(value=V4_37_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public JsonNode getCurrent()

Gets the change feed current item.

Returns:

change feed current item.

getPrevious

@Beta(value=V4_37_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public JsonNode getPrevious()

Gets the change feed previous item. For delete operations, previous image is always going to be provided. The previous image on replace operations is not going to be exposed by default and requires account-level or container-level opt-in.

Returns:

change feed previous item.

getChangeFeedMetaData

@Beta(value=V4_37_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public ChangeFeedMetaData getChangeFeedMetaData()

Gets the change feed metadata.

Returns:

change feed metadata.

toJsonNode

@Beta(value=V4_37_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public JsonNode toJsonNode()

Helper API to convert this changeFeedProcessorItem instance to raw JsonNode format.

Returns:

jsonNode format of this changeFeedProcessorItem instance.

Throws:

IllegalArgumentException - If conversion fails due to incompatible type; if so, root cause will contain underlying checked exception data binding functionality threw

toString

public String toString()

Overrides:

toString in class Object