Interface IngestionStartOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
IngestionStart, IngestionStart.Builder
public interface IngestionStartOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    DeduplicationMode
    getDeduplicationMode()
    Deduplication strategy for this stream.
    int
    getDeduplicationModeValue()
    Deduplication strategy for this stream.
    IngestionDefaults
    getDefaults()
    Initial ingestion defaults for the stream, letting the client establish its defaults up front instead of following the Start frame with a separate IngestionDefaults frame.
    IngestionDefaultsOrBuilder
    getDefaultsOrBuilder()
    Initial ingestion defaults for the stream, letting the client establish its defaults up front instead of following the Start frame with a separate IngestionDefaults frame.
    String
    getIntegration()
    Integration identification in format `name/version` Max length is 64 bytes
    com.google.protobuf.ByteString
    getIntegrationBytes()
    Integration identification in format `name/version` Max length is 64 bytes
    String
    getProducerId()
    Stable identity of the *producer*, not of this particular stream.
    com.google.protobuf.ByteString
    getProducerIdBytes()
    Stable identity of the *producer*, not of this particular stream.
    boolean
    hasDefaults()
    Initial ingestion defaults for the stream, letting the client establish its defaults up front instead of following the Start frame with a separate IngestionDefaults frame.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getProducerId

      String getProducerId()
      Stable identity of the *producer*, not of this particular stream.

The ID is an opaque string: this API is generic, so the server
attaches no format or meaning to it. It is entirely up to the producer
to pick an ID that uniquely identifies a single source of sequential,
ordered messages, since offsets are only meaningful relative to that
source. For a Kafka-based producer, for instance, an ID composed of
cluster + topic + consumer-group + partition would identify such a
source.

Depending on the DedupMode, the same producer must reuse the same
ID across streams (including after reconnects), otherwise deduplication
cannot work: the server tracks committed offsets per producer ID,
so a new ID starts a fresh deduplication state and previously committed
records may be duplicated.

The ID must be unique across producers: two distinct producers
sharing an ID will be treated as one and will shadow each other's
offsets.

Max length is 256 bytes.
      string producer_id = 1;
      Returns:
      The producerId.

    • getProducerIdBytes

      com.google.protobuf.ByteString getProducerIdBytes()
      Stable identity of the *producer*, not of this particular stream.

The ID is an opaque string: this API is generic, so the server
attaches no format or meaning to it. It is entirely up to the producer
to pick an ID that uniquely identifies a single source of sequential,
ordered messages, since offsets are only meaningful relative to that
source. For a Kafka-based producer, for instance, an ID composed of
cluster + topic + consumer-group + partition would identify such a
source.

Depending on the DedupMode, the same producer must reuse the same
ID across streams (including after reconnects), otherwise deduplication
cannot work: the server tracks committed offsets per producer ID,
so a new ID starts a fresh deduplication state and previously committed
records may be duplicated.

The ID must be unique across producers: two distinct producers
sharing an ID will be treated as one and will shadow each other's
offsets.

Max length is 256 bytes.
      string producer_id = 1;
      Returns:
      The bytes for producerId.

    • getIntegration

      String getIntegration()
      Integration identification in format `name/version`
Max length is 64 bytes
      string integration = 2;
      Returns:
      The integration.

    • getIntegrationBytes

      com.google.protobuf.ByteString getIntegrationBytes()
      Integration identification in format `name/version`
Max length is 64 bytes
      string integration = 2;
      Returns:
      The bytes for integration.

    • getDeduplicationModeValue

      int getDeduplicationModeValue()
      Deduplication strategy for this stream. Defaults to `DISABLED`.
      .dev.restate.ingress.ingestion.v1.DeduplicationMode deduplication_mode = 3;
      Returns:
      The enum numeric value on the wire for deduplicationMode.

    • getDeduplicationMode

      DeduplicationMode getDeduplicationMode()
      Deduplication strategy for this stream. Defaults to `DISABLED`.
      .dev.restate.ingress.ingestion.v1.DeduplicationMode deduplication_mode = 3;
      Returns:
      The deduplicationMode.

    • hasDefaults

      boolean hasDefaults()
      Initial ingestion defaults for the stream, letting the client
establish its defaults up front instead of following
the Start frame with a separate IngestionDefaults frame.
Clients can still send further IngestionDefaults frames later
to update these defaults during the stream.
      .dev.restate.ingress.ingestion.v1.IngestionDefaults defaults = 4;
      Returns:
      Whether the defaults field is set.

    • getDefaults

      IngestionDefaults getDefaults()
      Initial ingestion defaults for the stream, letting the client
establish its defaults up front instead of following
the Start frame with a separate IngestionDefaults frame.
Clients can still send further IngestionDefaults frames later
to update these defaults during the stream.
      .dev.restate.ingress.ingestion.v1.IngestionDefaults defaults = 4;
      Returns:
      The defaults.

    • getDefaultsOrBuilder

      IngestionDefaultsOrBuilder getDefaultsOrBuilder()
      Initial ingestion defaults for the stream, letting the client
establish its defaults up front instead of following
the Start frame with a separate IngestionDefaults frame.
Clients can still send further IngestionDefaults frames later
to update these defaults during the stream.
      .dev.restate.ingress.ingestion.v1.IngestionDefaults defaults = 4;