io.kurrentdb.protocol.v2.streams

Interface AppendRecordOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AppendRecord, AppendRecord.Builder

public interface AppendRecordOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsProperties(java.lang.String key) A collection of properties providing additional information about the record.
com.google.protobuf.ByteString	getData() The record payload as raw bytes.
java.util.Map<java.lang.String,com.google.protobuf.Value>	getProperties() Deprecated.
int	getPropertiesCount() A collection of properties providing additional information about the record.
java.util.Map<java.lang.String,com.google.protobuf.Value>	getPropertiesMap() A collection of properties providing additional information about the record.
com.google.protobuf.Value	getPropertiesOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue) A collection of properties providing additional information about the record.
com.google.protobuf.Value	getPropertiesOrThrow(java.lang.String key) A collection of properties providing additional information about the record.
java.lang.String	getRecordId() Unique identifier for this record (must be a valid UUID/GUID).
com.google.protobuf.ByteString	getRecordIdBytes() Unique identifier for this record (must be a valid UUID/GUID).
SchemaInfo	getSchema() Schema information for this record.
SchemaInfoOrBuilder	getSchemaOrBuilder() Schema information for this record.
boolean	hasRecordId() Unique identifier for this record (must be a valid UUID/GUID).
boolean	hasSchema() Schema information for this record.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasRecordId

boolean hasRecordId()

 Unique identifier for this record (must be a valid UUID/GUID).
 If not provided, the server will generate a new one.
 

optional string record_id = 1;

Returns:

Whether the recordId field is set.

getRecordId

java.lang.String getRecordId()

 Unique identifier for this record (must be a valid UUID/GUID).
 If not provided, the server will generate a new one.
 

optional string record_id = 1;

Returns:

The recordId.

getRecordIdBytes

com.google.protobuf.ByteString getRecordIdBytes()

 Unique identifier for this record (must be a valid UUID/GUID).
 If not provided, the server will generate a new one.
 

optional string record_id = 1;

Returns:

The bytes for recordId.

getPropertiesCount

int getPropertiesCount()

 A collection of properties providing additional information about the
 record. Can contain user-defined or system propreties.
 System keys will be prefixed with "$" (e.g., "$timestamp").
 User-defined keys MUST NOT start with "$".

 Common examples:
 User metadata:
 - "user-id": "12345"
 - "tenant": "acme-corp"
 - "source": "mobile-app"

 System metadata (with $ prefix):
 - "$trace-id": "4bf92f3577b34da6a3ce929d0e0e4736"  // OpenTelemetry trace ID
 - "$span-id": "00f067aa0ba902b7"                   // OpenTelemetry span ID
 - "$timestamp": "2025-01-15T10:30:00.000Z"         // ISO 8601 timestamp
 

map<string, .google.protobuf.Value> properties = 2;

containsProperties

boolean containsProperties(java.lang.String key)

 A collection of properties providing additional information about the
 record. Can contain user-defined or system propreties.
 System keys will be prefixed with "$" (e.g., "$timestamp").
 User-defined keys MUST NOT start with "$".

 Common examples:
 User metadata:
 - "user-id": "12345"
 - "tenant": "acme-corp"
 - "source": "mobile-app"

 System metadata (with $ prefix):
 - "$trace-id": "4bf92f3577b34da6a3ce929d0e0e4736"  // OpenTelemetry trace ID
 - "$span-id": "00f067aa0ba902b7"                   // OpenTelemetry span ID
 - "$timestamp": "2025-01-15T10:30:00.000Z"         // ISO 8601 timestamp
 

map<string, .google.protobuf.Value> properties = 2;

getProperties

@Deprecated
java.util.Map<java.lang.String,com.google.protobuf.Value> getProperties()

Deprecated.

Use getPropertiesMap() instead.

getPropertiesMap

java.util.Map<java.lang.String,com.google.protobuf.Value> getPropertiesMap()

 A collection of properties providing additional information about the
 record. Can contain user-defined or system propreties.
 System keys will be prefixed with "$" (e.g., "$timestamp").
 User-defined keys MUST NOT start with "$".

 Common examples:
 User metadata:
 - "user-id": "12345"
 - "tenant": "acme-corp"
 - "source": "mobile-app"

 System metadata (with $ prefix):
 - "$trace-id": "4bf92f3577b34da6a3ce929d0e0e4736"  // OpenTelemetry trace ID
 - "$span-id": "00f067aa0ba902b7"                   // OpenTelemetry span ID
 - "$timestamp": "2025-01-15T10:30:00.000Z"         // ISO 8601 timestamp
 

map<string, .google.protobuf.Value> properties = 2;

getPropertiesOrDefault

com.google.protobuf.Value getPropertiesOrDefault(java.lang.String key,
                                                 com.google.protobuf.Value defaultValue)

 A collection of properties providing additional information about the
 record. Can contain user-defined or system propreties.
 System keys will be prefixed with "$" (e.g., "$timestamp").
 User-defined keys MUST NOT start with "$".

 Common examples:
 User metadata:
 - "user-id": "12345"
 - "tenant": "acme-corp"
 - "source": "mobile-app"

 System metadata (with $ prefix):
 - "$trace-id": "4bf92f3577b34da6a3ce929d0e0e4736"  // OpenTelemetry trace ID
 - "$span-id": "00f067aa0ba902b7"                   // OpenTelemetry span ID
 - "$timestamp": "2025-01-15T10:30:00.000Z"         // ISO 8601 timestamp
 

map<string, .google.protobuf.Value> properties = 2;

getPropertiesOrThrow

com.google.protobuf.Value getPropertiesOrThrow(java.lang.String key)

 A collection of properties providing additional information about the
 record. Can contain user-defined or system propreties.
 System keys will be prefixed with "$" (e.g., "$timestamp").
 User-defined keys MUST NOT start with "$".

 Common examples:
 User metadata:
 - "user-id": "12345"
 - "tenant": "acme-corp"
 - "source": "mobile-app"

 System metadata (with $ prefix):
 - "$trace-id": "4bf92f3577b34da6a3ce929d0e0e4736"  // OpenTelemetry trace ID
 - "$span-id": "00f067aa0ba902b7"                   // OpenTelemetry span ID
 - "$timestamp": "2025-01-15T10:30:00.000Z"         // ISO 8601 timestamp
 

map<string, .google.protobuf.Value> properties = 2;

hasSchema

boolean hasSchema()

 Schema information for this record.
 

.kurrentdb.protocol.v2.streams.SchemaInfo schema = 3;

Returns:

Whether the schema field is set.

getSchema

SchemaInfo getSchema()

 Schema information for this record.
 

.kurrentdb.protocol.v2.streams.SchemaInfo schema = 3;

Returns:

The schema.

getSchemaOrBuilder

SchemaInfoOrBuilder getSchemaOrBuilder()

 Schema information for this record.
 

.kurrentdb.protocol.v2.streams.SchemaInfo schema = 3;

getData

com.google.protobuf.ByteString getData()

 The record payload as raw bytes.
 The format specified in SchemaInfo determines how to interpret these bytes.
 

bytes data = 4;

Returns:

The data.