namespace

type Context struct {
	ID     ident.ID
	Schema SchemaDescr
}

type DynamicOptions interface {
	// Validate validates the options
	Validate() error

	// SetInstrumentOptions sets the instrumentation options
	SetInstrumentOptions(value instrument.Options) DynamicOptions

	// InstrumentOptions returns the instrumentation options
	InstrumentOptions() instrument.Options

	// SetConfigServiceClient sets the client of ConfigService
	SetConfigServiceClient(c client.Client) DynamicOptions

	// ConfigServiceClient returns the client of ConfigService
	ConfigServiceClient() client.Client

	// SetNamespaceRegistryKey sets the kv-store key used for the
	// NamespaceRegistry
	SetNamespaceRegistryKey(k string) DynamicOptions

	// NamespaceRegistryKey returns the kv-store key used for the
	// NamespaceRegistry
	NamespaceRegistryKey() string
}

type IndexConfiguration struct {
	Enabled   bool          `yaml:"enabled" validate:"nonzero"`
	BlockSize time.Duration `yaml:"blockSize" validate:"nonzero"`
}

type IndexOptions interface {
	// Equal returns true if the provide value is equal to this one.
	Equal(value IndexOptions) bool

	// SetEnabled sets whether indexing is enabled.
	SetEnabled(value bool) IndexOptions

	// Enabled returns whether indexing is enabled.
	Enabled() bool

	// SetBlockSize returns the block size.
	SetBlockSize(value time.Duration) IndexOptions

	// BlockSize returns the block size.
	BlockSize() time.Duration
}

type Initializer interface {
	// Init will return a new Registry
	Init() (Registry, error)
}

type Map interface {
	// Equal returns true if the provide value is equal to this one
	Equal(value Map) bool

	// Get gets the metadata for the provided namespace
	Get(ident.ID) (Metadata, error)

	// IDs returns the ID of known namespaces
	IDs() []ident.ID

	// Metadatas returns the metadata of known namespaces
	Metadatas() []Metadata
}

type MapConfiguration struct {
	Metadatas []MetadataConfiguration `yaml:"metadatas" validate:"nonzero"`
}

type MessageDescriptor struct {
	*desc.MessageDescriptor
}

type Metadata interface {
	// Equal returns true if the provide value is equal to this one
	Equal(value Metadata) bool

	// ID is the ID of the namespace
	ID() ident.ID

	// Options is the namespace options
	Options() Options
}

type MetadataConfiguration struct {
	ID                string                  `yaml:"id" validate:"nonzero"`
	BootstrapEnabled  *bool                   `yaml:"bootstrapEnabled"`
	FlushEnabled      *bool                   `yaml:"flushEnabled"`
	WritesToCommitLog *bool                   `yaml:"writesToCommitLog"`
	CleanupEnabled    *bool                   `yaml:"cleanupEnabled"`
	RepairEnabled     *bool                   `yaml:"repairEnabled"`
	ColdWritesEnabled *bool                   `yaml:"coldWritesEnabled"`
	Retention         retention.Configuration `yaml:"retention" validate:"nonzero"`
	Index             IndexConfiguration      `yaml:"index"`
}

type MetadataMatcher interface {
	gomock.Matcher
}

type MockDynamicOptions struct {
	// contains filtered or unexported fields
}

type MockDynamicOptionsMockRecorder struct {
	// contains filtered or unexported fields
}

type MockIndexOptions struct {
	// contains filtered or unexported fields
}

type MockIndexOptionsMockRecorder struct {
	// contains filtered or unexported fields
}

type MockInitializer struct {
	// contains filtered or unexported fields
}

type MockInitializerMockRecorder struct {
	// contains filtered or unexported fields
}

type MockMap struct {
	// contains filtered or unexported fields
}

type MockMapMockRecorder struct {
	// contains filtered or unexported fields
}

type MockMetadata struct {
	// contains filtered or unexported fields
}

type MockMetadataMockRecorder struct {
	// contains filtered or unexported fields
}

type MockOptions struct {
	// contains filtered or unexported fields
}

type MockOptionsMockRecorder struct {
	// contains filtered or unexported fields
}

type MockRegistry struct {
	// contains filtered or unexported fields
}

type MockRegistryMockRecorder struct {
	// contains filtered or unexported fields
}

type MockSchemaDescr struct {
	// contains filtered or unexported fields
}

type MockSchemaDescrMockRecorder struct {
	// contains filtered or unexported fields
}

type MockSchemaHistory struct {
	// contains filtered or unexported fields
}

type MockSchemaHistoryMockRecorder struct {
	// contains filtered or unexported fields
}

type MockSchemaListener struct {
	// contains filtered or unexported fields
}

type MockSchemaListenerMockRecorder struct {
	// contains filtered or unexported fields
}

type MockSchemaRegistry struct {
	// contains filtered or unexported fields
}

type MockSchemaRegistryMockRecorder struct {
	// contains filtered or unexported fields
}

type MockWatch struct {
	// contains filtered or unexported fields
}

type MockWatchMockRecorder struct {
	// contains filtered or unexported fields
}

type Options interface {
	// Validate validates the options
	Validate() error

	// Equal returns true if the provide value is equal to this one
	Equal(value Options) bool

	// SetBootstrapEnabled sets whether this namespace requires bootstrapping
	SetBootstrapEnabled(value bool) Options

	// BootstrapEnabled returns whether this namespace requires bootstrapping
	BootstrapEnabled() bool

	// SetFlushEnabled sets whether the in-memory data for this namespace needs to be flushed
	SetFlushEnabled(value bool) Options

	// FlushEnabled returns whether the in-memory data for this namespace needs to be flushed
	FlushEnabled() bool

	// SetSnapshotEnabled sets whether the in-memory data for this namespace should be snapshotted regularly
	SetSnapshotEnabled(value bool) Options

	// SnapshotEnabled returns whether the in-memory data for this namespace should be snapshotted regularly
	SnapshotEnabled() bool

	// SetWritesToCommitLog sets whether writes for series in this namespace need to go to commit log
	SetWritesToCommitLog(value bool) Options

	// WritesToCommitLog returns whether writes for series in this namespace need to go to commit log
	WritesToCommitLog() bool

	// SetCleanupEnabled sets whether this namespace requires cleaning up fileset/snapshot files
	SetCleanupEnabled(value bool) Options

	// CleanupEnabled returns whether this namespace requires cleaning up fileset/snapshot files
	CleanupEnabled() bool

	// SetRepairEnabled sets whether the data for this namespace needs to be repaired
	SetRepairEnabled(value bool) Options

	// RepairEnabled returns whether the data for this namespace needs to be repaired
	RepairEnabled() bool

	// SetColdWritesEnabled sets whether cold writes are enabled for this namespace.
	SetColdWritesEnabled(value bool) Options

	// ColdWritesEnabled returns whether cold writes are enabled for this namespace.
	ColdWritesEnabled() bool

	// SetRetentionOptions sets the retention options for this namespace
	SetRetentionOptions(value retention.Options) Options

	// RetentionOptions returns the retention options for this namespace
	RetentionOptions() retention.Options

	// SetIndexOptions sets the IndexOptions.
	SetIndexOptions(value IndexOptions) Options

	// IndexOptions returns the IndexOptions.
	IndexOptions() IndexOptions

	// SetSchemaHistory sets the schema registry for this namespace.
	SetSchemaHistory(value SchemaHistory) Options

	// SchemaHistory returns the schema registry for this namespace.
	SchemaHistory() SchemaHistory
}

type Registry interface {
	// Watch for the Registry changes
	Watch() (Watch, error)

	// Close closes the registry
	Close() error
}

type SchemaDescr interface {
	// DeployId returns the deploy id of the schema.
	DeployId() string
	// PrevDeployId returns the previous deploy id of the schema.
	PrevDeployId() string
	// Get returns the message descriptor for the schema.
	Get() MessageDescriptor
	// String returns the compact text of the message descriptor.
	String() string
	// Equal returns true if the provided value is equal to this one.
	Equal(SchemaDescr) bool
}

type SchemaHistory interface {
	// Equal returns true if the provided value is equal to this one.
	Equal(SchemaHistory) bool

	// Extends returns true iif the provided value has a lineage to this one.
	Extends(SchemaHistory) bool

	// Get gets the schema descriptor for the specified deploy id.
	Get(id string) (SchemaDescr, bool)

	// GetLatest gets the latest version of schema descriptor.
	GetLatest() (SchemaDescr, bool)
}

type SchemaListener interface {
	// SetSchema is called when the listener is registered
	// and when any updates occurred passing the new schema history.
	SetSchema(value SchemaDescr)
}

type SchemaRegistry interface {
	// GetLatestSchema gets the latest schema for the namespace.
	// If proto is not enabled, nil, nil is returned
	GetLatestSchema(id ident.ID) (SchemaDescr, error)

	// GetSchema gets the latest schema for the namespace.
	// If proto is not enabled, nil, nil is returned
	GetSchema(id ident.ID, schemaId string) (SchemaDescr, error)

	// SetSchemaHistory sets the schema history for the namespace.
	// If proto is not enabled, nil is returned
	SetSchemaHistory(id ident.ID, history SchemaHistory) error

	// RegisterListener registers a schema listener for the namespace.
	// If proto is not enabled, nil, nil is returned
	RegisterListener(id ident.ID, listener SchemaListener) (xclose.SimpleCloser, error)

	// Close closes all the listeners.
	Close()
}

type Watch interface {
	// C is the notification channel for when a value becomes available
	C() <-chan struct{}

	// Get the current namespace map
	Get() Map

	// Close closes the watch
	Close() error
}