api

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 31, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConnectorAPIv1 

type ConnectorAPIv1 struct {
	apiv1.UnimplementedConnectorServiceServer
	// contains filtered or unexported fields
}

func NewConnectorAPIv1 

func NewConnectorAPIv1(cs ConnectorOrchestrator) *ConnectorAPIv1

func (*ConnectorAPIv1) CreateConnector 

func (c *ConnectorAPIv1) CreateConnector(
	ctx context.Context,
	req *apiv1.CreateConnectorRequest,
) (*apiv1.CreateConnectorResponse, error)

CreateConnector handles a CreateConnectorRequest, persists it to the Storage layer, and then returns the created connector with its assigned ID

func (*ConnectorAPIv1) DeleteConnector 

func (c *ConnectorAPIv1) DeleteConnector(ctx context.Context, req *apiv1.DeleteConnectorRequest) (*apiv1.DeleteConnectorResponse, error)

func (*ConnectorAPIv1) GetConnector 

func (c *ConnectorAPIv1) GetConnector(
	ctx context.Context,
	req *apiv1.GetConnectorRequest,
) (*apiv1.GetConnectorResponse, error)

GetConnector returns a single Connector proto response or an error.

func (*ConnectorAPIv1) InspectConnector added in v0.4.0 

func (c *ConnectorAPIv1) InspectConnector(req *apiv1.InspectConnectorRequest, server apiv1.ConnectorService_InspectConnectorServer) error

func (*ConnectorAPIv1) ListConnectors 

func (c *ConnectorAPIv1) ListConnectors(
	ctx context.Context,
	req *apiv1.ListConnectorsRequest,
) (*apiv1.ListConnectorsResponse, error)

func (*ConnectorAPIv1) Register 

func (c *ConnectorAPIv1) Register(srv *grpc.Server)

func (*ConnectorAPIv1) UpdateConnector 

func (c *ConnectorAPIv1) UpdateConnector(
	ctx context.Context,
	req *apiv1.UpdateConnectorRequest,
) (*apiv1.UpdateConnectorResponse, error)

func (*ConnectorAPIv1) ValidateConnector added in v0.2.1 

func (c *ConnectorAPIv1) ValidateConnector(
	ctx context.Context,
	req *apiv1.ValidateConnectorRequest,
) (*apiv1.ValidateConnectorResponse, error)

ValidateConnector validates whether the connector configurations are valid or not returns an empty response if valid, an error otherwise

type ConnectorOrchestrator 

type ConnectorOrchestrator interface {
	Create(ctx context.Context, t connector.Type, plugin string, pipelineID string, config connector.Config) (*connector.Instance, error)
	List(ctx context.Context) map[string]*connector.Instance
	Get(ctx context.Context, id string) (*connector.Instance, error)
	Delete(ctx context.Context, id string) error
	Update(ctx context.Context, id string, config connector.Config) (*connector.Instance, error)
	Validate(ctx context.Context, t connector.Type, plugin string, config connector.Config) error
	Inspect(ctx context.Context, id string) (*inspector.Session, error)
}

type HealthChecker 

type HealthChecker struct {
	grpc_health_v1.UnimplementedHealthServer
}

func NewHealthChecker 

func NewHealthChecker() *HealthChecker

func (*HealthChecker) Check 

func (s *HealthChecker) Check(ctx context.Context, req *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)

func (*HealthChecker) Watch 

func (s *HealthChecker) Watch(req *grpc_health_v1.HealthCheckRequest, server grpc_health_v1.Health_WatchServer) error

type Information 

type Information struct {
	apiv1.UnimplementedInformationServiceServer
	// contains filtered or unexported fields
}

func NewInformation 

func NewInformation(version string) *Information

func (*Information) GetInfo 

func (i *Information) GetInfo(ctx context.Context, req *apiv1.GetInfoRequest) (*apiv1.GetInfoResponse, error)

func (*Information) Register 

func (i *Information) Register(srv *grpc.Server)

type PipelineAPIv1 

type PipelineAPIv1 struct {
	apiv1.UnimplementedPipelineServiceServer
	// contains filtered or unexported fields
}

func NewPipelineAPIv1 

func NewPipelineAPIv1(ps PipelineOrchestrator) *PipelineAPIv1

NewPipelineAPIv1 returns a new pipeline API server.

func (*PipelineAPIv1) CreatePipeline 

func (p *PipelineAPIv1) CreatePipeline(
	ctx context.Context,
	req *apiv1.CreatePipelineRequest,
) (*apiv1.CreatePipelineResponse, error)

CreatePipeline handles a CreatePipelineRequest, persists it to the Storage layer, and then returns the created pipeline with its assigned ID

func (*PipelineAPIv1) DeletePipeline 

func (p *PipelineAPIv1) DeletePipeline(
	ctx context.Context,
	req *apiv1.DeletePipelineRequest,
) (*apiv1.DeletePipelineResponse, error)

func (*PipelineAPIv1) ExportPipeline 

func (p *PipelineAPIv1) ExportPipeline(
	ctx context.Context,
	req *apiv1.ExportPipelineRequest,
) (*apiv1.ExportPipelineResponse, error)

func (*PipelineAPIv1) GetDLQ added in v0.5.0 

func (p *PipelineAPIv1) GetDLQ(
	ctx context.Context,
	req *apiv1.GetDLQRequest,
) (*apiv1.GetDLQResponse, error)

func (*PipelineAPIv1) GetPipeline 

func (p *PipelineAPIv1) GetPipeline(
	ctx context.Context,
	req *apiv1.GetPipelineRequest,
) (*apiv1.GetPipelineResponse, error)

GetPipeline returns a single Pipeline proto response or an error.

func (*PipelineAPIv1) ImportPipeline 

func (p *PipelineAPIv1) ImportPipeline(
	ctx context.Context,
	req *apiv1.ImportPipelineRequest,
) (*apiv1.ImportPipelineResponse, error)

func (*PipelineAPIv1) ListPipelines 

func (p *PipelineAPIv1) ListPipelines(
	ctx context.Context,
	req *apiv1.ListPipelinesRequest,
) (*apiv1.ListPipelinesResponse, error)

ListPipelines returns a list of all pipelines.

func (*PipelineAPIv1) Register 

func (p *PipelineAPIv1) Register(srv *grpc.Server)

Register registers the service in the server.

func (*PipelineAPIv1) StartPipeline 

func (p *PipelineAPIv1) StartPipeline(
	ctx context.Context,
	req *apiv1.StartPipelineRequest,
) (*apiv1.StartPipelineResponse, error)

func (*PipelineAPIv1) StopPipeline 

func (p *PipelineAPIv1) StopPipeline(
	ctx context.Context,
	req *apiv1.StopPipelineRequest,
) (*apiv1.StopPipelineResponse, error)

func (*PipelineAPIv1) UpdateDLQ added in v0.5.0 

func (p *PipelineAPIv1) UpdateDLQ(
	ctx context.Context,
	req *apiv1.UpdateDLQRequest,
) (*apiv1.UpdateDLQResponse, error)

func (*PipelineAPIv1) UpdatePipeline 

func (p *PipelineAPIv1) UpdatePipeline(
	ctx context.Context,
	req *apiv1.UpdatePipelineRequest,
) (*apiv1.UpdatePipelineResponse, error)

type PipelineOrchestrator 

type PipelineOrchestrator interface {
	// Start runs a pipeline.
	Start(ctx context.Context, id string) error
	// Stop stops a pipeline.
	Stop(ctx context.Context, id string) error
	// List will return all pipelines stored in it.
	List(ctx context.Context) map[string]*pipeline.Instance
	// Get will return a single Pipeline or an error if it doesn't exist.
	Get(ctx context.Context, id string) (*pipeline.Instance, error)
	// Create will make a new Pipeline.
	Create(ctx context.Context, cfg pipeline.Config) (*pipeline.Instance, error)
	// Update will update a Pipeline's config.
	Update(ctx context.Context, id string, cfg pipeline.Config) (*pipeline.Instance, error)
	// UpdateDLQ will update a Pipeline's dead-letter-queue.
	UpdateDLQ(ctx context.Context, id string, dlq pipeline.DLQ) (*pipeline.Instance, error)
	// Delete removes a pipeline and all associated connectors and plugins.
	Delete(ctx context.Context, id string) error
}

PipelineOrchestrator defines a CRUD interface that manages the Pipeline resource.

type PluginAPIv1 added in v0.2.0 

type PluginAPIv1 struct {
	apiv1.UnimplementedPluginServiceServer
	// contains filtered or unexported fields
}

func NewPluginAPIv1 added in v0.2.0 

func NewPluginAPIv1(ps PluginOrchestrator) *PluginAPIv1

func (*PluginAPIv1) ListPlugins added in v0.2.0 

func (p *PluginAPIv1) ListPlugins(
	ctx context.Context,
	req *apiv1.ListPluginsRequest,
) (*apiv1.ListPluginsResponse, error)

func (*PluginAPIv1) Register added in v0.2.0 

func (p *PluginAPIv1) Register(srv *grpc.Server)

type PluginOrchestrator added in v0.2.0 

type PluginOrchestrator interface {
	// List will return all plugins' specs.
	List(ctx context.Context) (map[string]plugin.Specification, error)
}

PluginOrchestrator defines a CRUD interface that manages the Plugin resource.

type ProcessorAPIv1 

type ProcessorAPIv1 struct {
	apiv1.UnimplementedProcessorServiceServer
	// contains filtered or unexported fields
}

func NewProcessorAPIv1 

func NewProcessorAPIv1(ps ProcessorOrchestrator) *ProcessorAPIv1

NewProcessorAPIv1 returns a new processor API server.

func (*ProcessorAPIv1) CreateProcessor 

func (p *ProcessorAPIv1) CreateProcessor(
	ctx context.Context,
	req *apiv1.CreateProcessorRequest,
) (*apiv1.CreateProcessorResponse, error)

CreateProcessor handles a CreateProcessorRequest, persists it to the Storage layer, and then returns the created processor with its assigned ID

func (*ProcessorAPIv1) DeleteProcessor 

func (p *ProcessorAPIv1) DeleteProcessor(ctx context.Context, req *apiv1.DeleteProcessorRequest) (*apiv1.DeleteProcessorResponse, error)

func (*ProcessorAPIv1) GetProcessor 

func (p *ProcessorAPIv1) GetProcessor(
	ctx context.Context,
	req *apiv1.GetProcessorRequest,
) (*apiv1.GetProcessorResponse, error)

GetProcessor returns a single Interface proto response or an error.

func (*ProcessorAPIv1) InspectProcessorIn added in v0.5.0 

func (p *ProcessorAPIv1) InspectProcessorIn(
	req *apiv1.InspectProcessorInRequest,
	server apiv1.ProcessorService_InspectProcessorInServer,
) error

func (*ProcessorAPIv1) InspectProcessorOut added in v0.5.0 

func (p *ProcessorAPIv1) InspectProcessorOut(
	req *apiv1.InspectProcessorOutRequest,
	server apiv1.ProcessorService_InspectProcessorOutServer,
) error

func (*ProcessorAPIv1) ListProcessors 

func (p *ProcessorAPIv1) ListProcessors(
	ctx context.Context,
	req *apiv1.ListProcessorsRequest,
) (*apiv1.ListProcessorsResponse, error)

func (*ProcessorAPIv1) Register 

func (p *ProcessorAPIv1) Register(srv *grpc.Server)

Register registers the service in the server.

func (*ProcessorAPIv1) UpdateProcessor 

func (p *ProcessorAPIv1) UpdateProcessor(
	ctx context.Context,
	req *apiv1.UpdateProcessorRequest,
) (*apiv1.UpdateProcessorResponse, error)

type ProcessorOrchestrator 

type ProcessorOrchestrator interface {
	List(ctx context.Context) map[string]*processor.Instance
	// Get will return a single Interface or an error if it doesn't exist.
	Get(ctx context.Context, id string) (*processor.Instance, error)
	// Create will make a new Interface.
	Create(ctx context.Context, procType string, parent processor.Parent, cfg processor.Config) (*processor.Instance, error)
	// Update will update a Interface's config.
	Update(ctx context.Context, id string, cfg processor.Config) (*processor.Instance, error)
	// Delete removes a processor
	Delete(ctx context.Context, id string) error
	// InspectIn starts an inspector session for the records coming into the processor with given ID.
	InspectIn(ctx context.Context, id string) (*inspector.Session, error)
	// InspectOut starts an inspector session for the records going out of the processor with given ID.
	InspectOut(ctx context.Context, id string) (*inspector.Session, error)
}

ProcessorOrchestrator defines a CRUD interface that manages the Interface resource.

Source Files

View all Source files

Directories

Path Synopsis
Package mock is a generated GoMock package.
 Package mock is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.