api

README

Meta Client

Meta Client is a library contains code to interactive with Seal Meta server, it's first consumers are github.com/seal-io/seal, github.com/seal-io/meta.

This repository is synchronized from https://github.com/seal-io/meta/api. Code changes are made in that location, merged into github.com/seal-io/meta and later synced here.

There are NO compatibility guarantees for this library, yet.

License

Copyright (c) 2022 Seal Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at LICENSE file for details.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

Index

• type Client
  • func GetClient(ctx context.Context, listenOn string) (Client, error)
• type IngestParser

Types

type Client

type Client interface {
	// Ingest ingests specified type dataset from the exposing service,
	// and parses dataset with the given IngestParser.
	Ingest(ctx context.Context, typ schema.DatasetIngestRequestType, since time.Time, parse IngestParser) (err error)

	// IngestAll ingests all types dataset from the exposing service,
	// and parses dataset with the given IngestParser.
	IngestAll(ctx context.Context, since time.Time, parse IngestParser) (err error)

	// Close closes the client.
	Close() error
}

Client holds the actions for receiving from the exposing service.

func GetClient

func GetClient(ctx context.Context, listenOn string) (Client, error)

GetClient returns the Client.

type IngestParser

type IngestParser func(currentWindow int32, body schema.DatasetIngestResponseBody) error

IngestParser is the parser to parse the given api.DatasetIngestResponseBody.