restapiservice

Documentation

Overview

One or two sentence synopsis of the package...

Overview

One or two paragraph overview of the package... (This page describes the nature of the individual package.)

More information at https://github.com/senzing/serve-http

Another Header

Details of the package... Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Examples

The examples given here should be specific to the package.

Examples of use can be seen in the examplepackage_test.go files.

package main
import (
	fmt

	"github.com/senzing/serve-http/examplepackage"
)

func main() {
	ctx := context.TODO()
	testObject := &ExamplePackageImpl{
		Something: "I'm here",
	}
	err := testObject.SaySomething(ctx)
	if err != nil {
		fmt.Println("whoops")
	}
}

Index

• Constants
• Variables
• type HttpService
• type HttpServiceImpl
  • func (httpService *HttpServiceImpl) AddDataSources(ctx context.Context, req api.AddDataSourcesReq, ...) (r api.AddDataSourcesRes, _ error)
  • func (httpService *HttpServiceImpl) Heartbeat(ctx context.Context) (r *api.SzBaseResponse, _ error)

Examples

• HttpServiceImpl.Heartbeat

Constants

const ComponentId = 9999

Identfier of the package found messages having the format "senzing-6503xxxx".

const Prefix = "serve-http.httpservice."

Log message prefix.

Variables

var IdMessages = map[int]string{
	10: "Enter " + Prefix + "InitializeSenzing().",
}

Message templates for g2config implementations.

var IdStatuses = map[int]string{}

Status strings for specific messages.

Types

type HttpService

type HttpService interface {
	senzingrestapi.Handler
}

The HttpService interface is...

type HttpServiceImpl

type HttpServiceImpl struct {
	api.UnimplementedHandler

	GrpcDialOptions []grpc.DialOption
	GrpcTarget      string

	LogLevelName                   string
	ObserverOrigin                 string
	Observers                      []observer.Observer
	Port                           int
	SenzingEngineConfigurationJson string
	SenzingModuleName              string
	SenzingVerboseLogging          int
	// contains filtered or unexported fields
}

HttpServiceImpl is...

func (*HttpServiceImpl) AddDataSources

func (httpService *HttpServiceImpl) AddDataSources(ctx context.Context, req api.AddDataSourcesReq, params api.AddDataSourcesParams) (r api.AddDataSourcesRes, _ error)

func (*HttpServiceImpl) Heartbeat

func (httpService *HttpServiceImpl) Heartbeat(ctx context.Context) (r *api.SzBaseResponse, _ error)

Example