api

Type Members

1. sealed abstract class Audience extends EnumEntry with Product with Serializable

   

2. final case class AuthorizationAttribute(dataType: String, value: String) extends Product with Serializable

   

3. final case class CancelledByClient(subscriptionId: SubscriptionId, streamId: StreamId) extends Exception with Product with Serializable

   

   Exception that is passed if the stream is cancelled by the client

4. sealed abstract class Category extends EnumEntry with Product with Serializable

   

5. sealed abstract class CleanupPolicy extends EnumEntry with Product with Serializable

   

6. final case class CommitCursorItemResponse(cursor: Cursor, result: String) extends Product with Serializable

   

7. final case class CommitCursorResponse(items: List[CommitCursorItemResponse]) extends Product with Serializable

   

8. sealed abstract class CompatibilityMode extends EnumEntry with Product with Serializable

   

9. sealed abstract class DataOperation extends EnumEntry with Product with Serializable

   

10. sealed abstract class EnrichmentStrategy extends EnumEntry with Product with Serializable

    

11. sealed abstract class Event[T] extends AnyRef

    

12. final case class EventType(name: EventTypeName, owningApplication: String, category: Category, enrichmentStrategies: List[EnrichmentStrategy] = ..., partitionStrategy: Option[PartitionStrategy] = None, compatibilityMode: Option[CompatibilityMode] = None, schema: EventTypeSchema = EventTypeSchema.anyJsonObject, partitionKeyFields: Option[List[String]] = None, cleanupPolicy: Option[CleanupPolicy] = None, defaultStatistic: Option[EventTypeStatistics] = None, options: Option[EventTypeOptions] = None, authorization: Option[EventTypeAuthorization] = None, writeScopes: Option[List[WriteScope]] = None, readScopes: Option[List[ReadScope]] = None, audience: Option[Audience] = None, orderingKeyFields: Option[List[String]] = None, orderingInstanceIds: Option[List[String]] = None, createdAt: Option[OffsetDateTime] = None, updatedAt: Option[OffsetDateTime] = None) extends Product with Serializable

    
    name

    Name of this EventType. The name is constrained by a regular expression. Note: the name can encode the owner/responsible for this EventType and ideally should follow a common pattern that makes it easy to read and understand, but this level of structure is not enforced. For example a team name and data type can be used such as 'acme-team.price-change'.

    owningApplication

    Indicator of the (Stups) Application owning this EventType.

    category

    Defines the category of this EventType. The value set will influence, if not set otherwise, the default set of validations, enrichmentStrategies, and the effective schema for validation in the following way: - Category.Undefined: No predefined changes apply. The effective schema for the validation is exactly the same as the EventTypeSchema. - data: Events of this category will be org.zalando.kanadi.api.Event.DataChange. The effective schema during the validation contains org.zalando.kanadi.api.Metadata, and adds fields org.zalando.kanadi.api.Event.DataChange.data and org.zalando.kanadi.api.Event.DataChange.dataType. The passed EventTypeSchema defines the schema of org.zalando.kanadi.api.Event.DataChange.data. - Category.Business: Events of this category will be org.zalando.kanadi.api.Event.Business. The effective schema for validation contains org.zalando.kanadi.api.Metadata and any additionally defined properties passed in the EventTypeSchema directly on top level of the org.zalando.kanadi.api.Event. If name conflicts arise, creation of this EventType will be rejected.

    enrichmentStrategies

    Determines the enrichment to be performed on an Event upon reception. Enrichment is performed once upon reception (and after validation) of an Event and is only possible on fields that are not defined on the incoming Event. For event types in categories 'business' or 'data' it's mandatory to use metadata_enrichment strategy. For 'undefined' event types it's not possible to use this strategy, since metadata field is not required. See documentation for the write operation for details on behaviour in case of unsuccessful enrichment.

    partitionStrategy

    Determines how the assignment of the event to a partition should be handled. For details of possible values, see org.zalando.kanadi.api.Registry.partitionStrategies.

    compatibilityMode

    Compatibility mode provides a mean for event owners to evolve their schema, given changes respect the semantics defined by this field. It's designed to be flexible enough so that producers can evolve their schemas while not inadvertently breaking existent consumers. Once defined, the compatibility mode is fixed, since otherwise it would break a predefined contract, declared by the producer. List of compatibility modes: - CompatibilityMode.Compatible: Consumers can reliably parse events produced under different versions. Every event published since the first version is still valid based on the newest schema. When in compatible mode, it's allowed to add new optional properties and definitions to an existing schema, but no other changes are allowed. Under this mode, the following org.zalando.kanadi.api.EventTypeSchema.Type.JsonSchema attributes are not supported: not, patternProperties, additionalProperties and additionalItems. When validating events, additional properties is false. - CompatibilityMode.Forward: Compatible schema changes are allowed. It's possible to use the full json schema specification for defining schemas. Consumers of forward compatible event types can safely read events tagged with the latest schema version as long as they follow the robustness principle. - CompatibilityMode.None: Any schema modification is accepted, even if it might break existing producers or consumers. When validating events, no additional properties are accepted unless explicitly stated in the schema.

    schema

    The most recent schema for this EventType. Submitted events will be validated against it.

    partitionKeyFields

    Required when partitionStrategy is set to org.zalando.kanadi.api.PartitionStrategy.Hash. Must be absent otherwise. Indicates the fields used for evaluation the partition of Events of this type. If set it MUST be a valid required field as defined in the schema.

    cleanupPolicy

    Event Type Cleanup Policy. 'delete' will delete old events after retention time expires. 'compact' will keep only the latest event for each event key. The key that will be used as a compaction key should be specified in PartitionCompactionKey.

    defaultStatistic

    Operational statistics for an EventType. This data MUST be provided by users on Event Type creation. Nakadi uses this object in order to provide an optimal number of partitions from a throughput perspective.

    options

    Additional parameters for tuning internal behavior of Nakadi.

    authorization

    Authorization section for an event type. This section defines three access control lists: one for producing events EventTypeAuthorization.writers, one for consuming events EventTypeAuthorization.readers, and one for administering an event type EventTypeAuthorization.admins. Regardless of the values of the authorization properties, administrator accounts will always be authorized.

    writeScopes

    This field is used for event publishing access control. Nakadi only authorises publishers whose session contains at least one of the scopes in this list. If no scopes provided then anyone can publish to this event type.

    readScopes

    This field is used for event consuming access control. Nakadi only authorises consumers whose session contains at least one of the scopes in this list. If no scopes provided then anyone can consume from this event type.

    audience

    Intended target audience of the event type.

    orderingKeyFields

    This is an optional field which can be useful in case the producer wants to communicate the complete order across all the events published to all the partitions.

    orderingInstanceIds

    Indicates which field represents the data instance identifier and scope in which ordering_key_fields provides a strict order.

    createdAt

    Date and time when this event type was created.

    updatedAt

    Date and time when this event type was last updated.

13. final case class EventTypeAuthorization(admins: List[AuthorizationAttribute], readers: List[AuthorizationAttribute], writers: List[AuthorizationAttribute]) extends Product with Serializable

    

14. final case class EventTypeOptions(retentionTime: Int) extends Product with Serializable

    

15. final case class EventTypeSchema(version: Option[String], createdAt: Option[OffsetDateTime], type: Type, schema: Json) extends Product with Serializable

    

16. final case class EventTypeStatistics(messagesPerMinute: Int, messageSize: Int, readParallelism: Int, writeParallelism: Int) extends Product with Serializable

    

17. case class EventTypes(baseUri: URI, oAuth2TokenProvider: Option[OAuth2TokenProvider] = None)(implicit kanadiHttpConfig: HttpConfig, http: HttpExt, materializer: Materializer) extends Product with Serializable

    

18. case class Events(baseUri: URI, oAuth2TokenProvider: Option[OAuth2TokenProvider] = None)(implicit kanadiHttpConfig: HttpConfig, http: HttpExt, materializer: Materializer) extends Product with Serializable

    

19. final case class Metadata(eid: EventId = EventId.random, occurredAt: OffsetDateTime = OffsetDateTime.now, eventType: Option[EventTypeName] = None, receivedAt: Option[OffsetDateTime] = None, parentEids: Option[List[EventId]] = None, flowId: Option[FlowId] = None, partition: Option[Partition] = None, partitionCompactionKey: Option[PartitionCompactionKey] = None, spanCtx: Option[SpanCtx] = None) extends Product with Serializable

    

20. sealed abstract class PartitionStrategy extends EnumEntry with Product with Serializable

    

21. case class Registry(baseUri: URI, oAuth2TokenProvider: Option[OAuth2TokenProvider] = None)(implicit kanadiHttpConfig: HttpConfig, http: HttpExt, materializer: Materializer) extends Product with Serializable

    

22. final case class Subscription(id: Option[SubscriptionId], owningApplication: String, eventTypes: Option[List[EventTypeName]] = None, consumerGroup: Option[String] = None, createdAt: Option[OffsetDateTime] = None, readFrom: Option[String] = None, initialCursors: Option[List[String]] = None, authorization: Option[SubscriptionAuthorization] = None) extends Product with Serializable

    

23. final case class SubscriptionAuthorization(admins: List[AuthorizationAttribute], readers: List[AuthorizationAttribute]) extends Product with Serializable

    

24. final case class SubscriptionCursor(items: List[Cursor]) extends Product with Serializable

    

25. final case class SubscriptionEvent[T](cursor: Cursor, info: Option[JsonObject], events: Option[List[Event[T]]]) extends Product with Serializable

    

26. final case class SubscriptionEventData[T](events: Option[List[Event[T]]]) extends Product with Serializable

    

27. final case class SubscriptionEventInfo(cursor: Cursor, info: Option[JsonObject]) extends Product with Serializable

    

28. final case class SubscriptionQuery(links: PaginationLinks, items: List[Subscription]) extends Product with Serializable

    

29. final case class SubscriptionStats(items: List[EventTypeStats]) extends Product with Serializable

    

30. case class Subscriptions(baseUri: URI, oAuth2TokenProvider: Option[OAuth2TokenProvider] = None)(implicit kanadiHttpConfig: HttpConfig, http: HttpExt, materializer: Materializer) extends Product with Serializable