Class

org.zalando.kanadi.api

EventTypes

Related Doc: package api

Permalink

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventTypes
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. EventTypesInterface
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EventTypes(baseUri: URI, oAuth2TokenProvider: Option[OAuth2TokenProvider] = None)(implicit kanadiHttpConfig: HttpConfig, http: HttpExt, materializer: Materializer)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. val baseUri: URI

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def create(eventType: EventType)(implicit flowId: FlowId = randomFlowId(), executionContext: ExecutionContext): Future[Unit]

    Permalink

    Creates a new EventType.

    Creates a new EventType.

    The fields enrichment-strategies and partition-resolution-strategy have all an effect on the incoming org.zalando.kanadi.api.Event of this EventType. For its impacts on the reception of events please consult the Event submission API methods. Validation strategies define an array of validation stategies to be evaluated on reception of an Event of this EventType. Details of usage can be found in this external document http://zalando.github.io/nakadi-manual/ Enrichment strategy. (todo: define this part of the API). The schema of an EventType is defined as an EventTypeSchema. Currently only the value EventTypeSchema.Type.JsonSchema is supported, representing JSON Schema draft 04.

    Following conditions are enforced. Not meeting them will fail the request with the indicated status (details are provided in the Problem object):

    EventType name on creation must be unique (or attempting to update an EventType with this method), otherwise the request is rejected with status 409 Conflict. Using EventTypeSchema.Type other than EventTypeSchema.Type.JsonSchema or passing a EventTypeSchema.schema that is invalid with respect to the schema's type. Rejects with 422 Unprocessable entity. Referring any Enrichment or Partition strategies that do not exist or whose parametrization is deemed invalid. Rejects with 422 Unprocessable entity.

    Nakadi MIGHT impose necessary schema, validation and enrichment minimal configurations that MUST be followed by all EventTypes (examples include: validation rules to match the schema; enriching every Event with the reception date-type; adhering to a set of schema fields that are mandatory for all EventTypes). The mechanism to set and inspect such rules is not defined at this time and might not be exposed in the API.

    flowId

    The flow id of the request, which is written into the logs and passed to called services. Helpful for operational troubleshooting and log analysis.

    Definition Classes
    EventTypesEventTypesInterface
  8. def delete(name: EventTypeName)(implicit flowId: FlowId = randomFlowId(), executionContext: ExecutionContext): Future[Unit]

    Permalink

    Deletes an EventType identified by its name.

    Deletes an EventType identified by its name. All events in the EventType's stream' will also be removed. Note: deletion happens asynchronously, which has the following consequences:

    Creation of an equally named EventType before the underlying topic deletion is complete might not succeed (failure is a 409 Conflict). Events in the stream may be visible for a short period of time before being removed.

    name

    Name of the EventType to delete.

    flowId

    The flow id of the request, which is written into the logs and passed to called services. Helpful for operational troubleshooting and log analysis.

    Definition Classes
    EventTypesEventTypesInterface
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def get(name: EventTypeName)(implicit flowId: FlowId = randomFlowId(), executionContext: ExecutionContext): Future[Option[EventType]]

    Permalink

    Returns the EventType identified by its name.

    Returns the EventType identified by its name.

    name

    Name of the EventType to load.

    flowId

    The flow id of the request, which is written into the logs and passed to called services. Helpful for operational troubleshooting and log analysis.

    Definition Classes
    EventTypesEventTypesInterface
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def list()(implicit flowId: FlowId = randomFlowId(), executionContext: ExecutionContext): Future[List[EventType]]

    Permalink

    Returns a list of all registered EventType

    Returns a list of all registered EventType

    flowId

    The flow id of the request, which is written into the logs and passed to called services. Helpful for operational troubleshooting and log analysis.

    Definition Classes
    EventTypesEventTypesInterface
  15. val logger: LoggerTakingImplicit[FlowId]

    Permalink
    Attributes
    protected
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val oAuth2TokenProvider: Option[OAuth2TokenProvider]

    Permalink
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def update(name: EventTypeName, eventType: EventType)(implicit flowId: FlowId = randomFlowId(), executionContext: ExecutionContext): Future[Unit]

    Permalink

    Updates the EventType identified by its name.

    Updates the EventType identified by its name. Behaviour is the same as creation of EventType (See create) except where noted below.

    name

    Name of the EventType to update.

    eventType

    EventType to be updated.

    flowId

    The flow id of the request, which is written into the logs and passed to called services. Helpful for operational troubleshooting and log analysis.

    Definition Classes
    EventTypesEventTypesInterface
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EventTypesInterface

Inherited from AnyRef

Inherited from Any

Ungrouped