Class IngestionStart

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
dev.restate.ingestion.v1.IngestionStart
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, IngestionStartOrBuilder, Serializable
public final class IngestionStart extends com.google.protobuf.GeneratedMessage implements IngestionStartOrBuilder
Required.
A Start frame must be sent before any IngestionDefaults or
IngestionInvocation frame.
Sending a Start frame again during the lifetime of
the stream is illegal: the server will return an
error and terminate the stream.

Invalid Start message will cause an error
to be returned immediately, and stream to be teared down
immediately
Protobuf type dev.restate.ingress.ingestion.v1.IngestionStart
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    IngestionStart.Builder
    Required.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEDUPLICATION_MODE_FIELD_NUMBER
     
    static final int
    DEFAULTS_FIELD_NUMBER
     
    static final int
    INTEGRATION_FIELD_NUMBER
     
    static final int
    PRODUCER_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    DeduplicationMode
    getDeduplicationMode()
    Deduplication strategy for this stream.
    int
    getDeduplicationModeValue()
    Deduplication strategy for this stream.
    static IngestionStart
    getDefaultInstance()
     
    IngestionStart
    getDefaultInstanceForType()
     
    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.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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
    com.google.protobuf.Parser<IngestionStart>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static IngestionStart.Builder
    newBuilder()
     
    static IngestionStart.Builder
    newBuilder(IngestionStart prototype)
     
    IngestionStart.Builder
    newBuilderForType()
     
    protected IngestionStart.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static IngestionStart
    parseDelimitedFrom(InputStream input)
     
    static IngestionStart
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IngestionStart
    parseFrom(byte[] data)
     
    static IngestionStart
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IngestionStart
    parseFrom(com.google.protobuf.ByteString data)
     
    static IngestionStart
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IngestionStart
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static IngestionStart
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IngestionStart
    parseFrom(InputStream input)
     
    static IngestionStart
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IngestionStart
    parseFrom(ByteBuffer data)
     
    static IngestionStart
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<IngestionStart>
    parser()
     
    IngestionStart.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PRODUCER_ID_FIELD_NUMBER

      public static final int PRODUCER_ID_FIELD_NUMBER
      See Also:

    • INTEGRATION_FIELD_NUMBER

      public static final int INTEGRATION_FIELD_NUMBER
      See Also:

    • DEDUPLICATION_MODE_FIELD_NUMBER

      public static final int DEDUPLICATION_MODE_FIELD_NUMBER
      See Also:

    • DEFAULTS_FIELD_NUMBER

      public static final int DEFAULTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getProducerId

      public 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;
      Specified by:
      getProducerId in interface IngestionStartOrBuilder
      Returns:
      The producerId.

    • getProducerIdBytes

      public 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;
      Specified by:
      getProducerIdBytes in interface IngestionStartOrBuilder
      Returns:
      The bytes for producerId.

    • getIntegration

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

    • getIntegrationBytes

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

    • getDeduplicationModeValue

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

    • getDeduplicationMode

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

    • hasDefaults

      public 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;
      Specified by:
      hasDefaults in interface IngestionStartOrBuilder
      Returns:
      Whether the defaults field is set.

    • getDefaults

      public 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;
      Specified by:
      getDefaults in interface IngestionStartOrBuilder
      Returns:
      The defaults.

    • getDefaultsOrBuilder

      public 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;
      Specified by:
      getDefaultsOrBuilder in interface IngestionStartOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static IngestionStart parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IngestionStart parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IngestionStart parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IngestionStart parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IngestionStart parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IngestionStart parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static IngestionStart parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IngestionStart parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IngestionStart parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static IngestionStart parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IngestionStart parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static IngestionStart parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public IngestionStart.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static IngestionStart.Builder newBuilder()

    • newBuilder

      public static IngestionStart.Builder newBuilder(IngestionStart prototype)

    • toBuilder

      public IngestionStart.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected IngestionStart.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static IngestionStart getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<IngestionStart> parser()

    • getParserForType

      public com.google.protobuf.Parser<IngestionStart> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public IngestionStart getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder