Skip to main content

model.go

model.go - Overview

  1. Overview Defines data structures and constants used for Kafka messaging queue integration.

  2. Detailed Documentation

Constants

KafkaQueue

  • Purpose: Defines a constant string representing the Kafka queue type.
  • Value: "kafka"

Type: MessagingQueue

  • Purpose: Represents a generic messaging queue data structure.
  • Fields:
    • Start: int64 - Start timestamp.
    • End: int64 - End timestamp.
    • EvalTime: int64 - Evaluation time (optional).
    • Variables: map[string]string - Map of string variables (optional).

Type: Clients

  • Purpose: Represents a structure for storing client-related information.
  • Fields:
    • Hash: map[string]struct{} - Hash map for string lookup. The empty struct struct{} consumes zero memory.
    • ClientID: []string - List of client IDs.
    • ServiceInstanceID: []string - List of service instance IDs.
    • ServiceName: []string - List of service names.
    • TopicName: []string - List of topic names.

Type: OnboardingResponse

  • Purpose: Represents a structure for onboarding responses.
  • Fields:
    • Attribute: string - Attribute related to the response.
    • Message: string - Error message.
    • Status: string - Status of the onboarding process.

Include in Getting Started: NO