data_object_enricher

Documentation

Index

• Constants
• Variables
• func RegisterDataObjectEnricherServiceServer(s grpc.ServiceRegistrar, srv DataObjectEnricherServiceServer)
• type DataObjectEnricher
• type DataObjectEnricherConfig
  • func (*DataObjectEnricherConfig) Descriptor() ([]byte, []int)
  • func (x *DataObjectEnricherConfig) GetConfigMap() *config.ConfigMap
  • func (x *DataObjectEnricherConfig) GetInputFile() string
  • func (x *DataObjectEnricherConfig) GetOutputFile() string
  • func (*DataObjectEnricherConfig) ProtoMessage()
  • func (x *DataObjectEnricherConfig) ProtoReflect() protoreflect.Message
  • func (x *DataObjectEnricherConfig) Reset()
  • func (x *DataObjectEnricherConfig) String() string
• type DataObjectEnricherPlugin
  • func (DataObjectEnricherPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *DataObjectEnricherPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error
• type DataObjectEnricherResult
  • func (*DataObjectEnricherResult) Descriptor() ([]byte, []int)
  • func (x *DataObjectEnricherResult) GetEnriched() int32
  • func (*DataObjectEnricherResult) ProtoMessage()
  • func (x *DataObjectEnricherResult) ProtoReflect() protoreflect.Message
  • func (x *DataObjectEnricherResult) Reset()
  • func (x *DataObjectEnricherResult) String() string
• type DataObjectEnricherServiceClient
  • func NewDataObjectEnricherServiceClient(cc grpc.ClientConnInterface) DataObjectEnricherServiceClient
• type DataObjectEnricherServiceServer
• type DataObjectEnricherVersionHandler
  • func (h *DataObjectEnricherVersionHandler) CliVersionInformation(ctx context.Context) (*version.CliBuildInformation, error)
• type UnimplementedDataObjectEnricherServiceServer
  • func (UnimplementedDataObjectEnricherServiceServer) CliVersionInformation(context.Context, *emptypb.Empty) (*version.CliBuildInformation, error)
  • func (UnimplementedDataObjectEnricherServiceServer) Enrich(context.Context, *DataObjectEnricherConfig) (*DataObjectEnricherResult, error)
• type UnsafeDataObjectEnricherServiceServer

Constants

const DataObjectEnricherName = "dataObjectEnricher"

DataObjectEnricherName constant should not be used directly when implementing plugins. It's the registration name for the data object enricher plugin, used by the CLI and the cli-plugin-base library (RegisterPlugins function) to register the plugins.

Variables

var DataObjectEnricherService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "data_object_enricher.DataObjectEnricherService",
	HandlerType: (*DataObjectEnricherServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CliVersionInformation",
			Handler:    _DataObjectEnricherService_CliVersionInformation_Handler,
		},
		{
			MethodName: "Enrich",
			Handler:    _DataObjectEnricherService_Enrich_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "data_object_enricher/data_object_enricher.proto",
}

DataObjectEnricherService_ServiceDesc is the grpc.ServiceDesc for DataObjectEnricherService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var File_data_object_enricher_data_object_enricher_proto protoreflect.FileDescriptor

var MinimalCliVersion = semver.MustParse("0.40.0-0")

Functions

func RegisterDataObjectEnricherServiceServer

func RegisterDataObjectEnricherServiceServer(s grpc.ServiceRegistrar, srv DataObjectEnricherServiceServer)

Types

type DataObjectEnricher

type DataObjectEnricher interface {
	version.CliVersionHandler

	Enrich(ctx context.Context, config *DataObjectEnricherConfig) (*DataObjectEnricherResult, error)
}

DataObjectEnricher interface needs to be implemented by any plugin that wants to enrich data objects, read by the data source sync. Enrichment will add additional metadata to the data objects, coming from different systems.

type DataObjectEnricherConfig

type DataObjectEnricherConfig struct {
	ConfigMap  *config.ConfigMap `protobuf:"bytes,1,opt,name=config_map,json=configMap,proto3" json:"config_map,omitempty"`
	InputFile  string            `protobuf:"bytes,2,opt,name=input_file,json=inputFile,proto3" json:"input_file,omitempty"`
	OutputFile string            `protobuf:"bytes,3,opt,name=output_file,json=outputFile,proto3" json:"output_file,omitempty"`
	// contains filtered or unexported fields
}

DataObjectEnricherConfig represents the configuration that is passed from the CLI to the DataObjectEnricher plugin interface. It contains all the necessary configuration parameters for the plugin to function.

func (*DataObjectEnricherConfig) Descriptor

func (*DataObjectEnricherConfig) Descriptor() ([]byte, []int)

Deprecated: Use DataObjectEnricherConfig.ProtoReflect.Descriptor instead.

func (*DataObjectEnricherConfig) GetConfigMap

func (x *DataObjectEnricherConfig) GetConfigMap() *config.ConfigMap

func (*DataObjectEnricherConfig) GetInputFile

func (x *DataObjectEnricherConfig) GetInputFile() string

func (*DataObjectEnricherConfig) GetOutputFile

func (x *DataObjectEnricherConfig) GetOutputFile() string

func (*DataObjectEnricherConfig) ProtoMessage

func (*DataObjectEnricherConfig) ProtoMessage()

func (*DataObjectEnricherConfig) ProtoReflect

func (x *DataObjectEnricherConfig) ProtoReflect() protoreflect.Message

func (*DataObjectEnricherConfig) Reset

func (x *DataObjectEnricherConfig) Reset()

func (*DataObjectEnricherConfig) String

func (x *DataObjectEnricherConfig) String() string

type DataObjectEnricherPlugin

type DataObjectEnricherPlugin struct {
	plugin.Plugin

	Impl DataObjectEnricher
}

DataObjectEnricherPlugin is used on the server (CLI) and client (plugin) side to integrate with the plugin system. A plugin should not be using this directly, but instead depend on the cli-plugin-base library to register the plugins.

func (DataObjectEnricherPlugin) GRPCClient

func (DataObjectEnricherPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (*DataObjectEnricherPlugin) GRPCServer

func (p *DataObjectEnricherPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type DataObjectEnricherResult

type DataObjectEnricherResult struct {
	Enriched int32 `protobuf:"varint,1,opt,name=enriched,proto3" json:"enriched,omitempty"`
	// contains filtered or unexported fields
}

DataObjectEnricherResult represents the result from the DataObjectEnricher process. A potential error is also modeled in here so specific errors remain intact when passed over RPC.

func (*DataObjectEnricherResult) Descriptor

func (*DataObjectEnricherResult) Descriptor() ([]byte, []int)

Deprecated: Use DataObjectEnricherResult.ProtoReflect.Descriptor instead.

func (*DataObjectEnricherResult) GetEnriched

func (x *DataObjectEnricherResult) GetEnriched() int32

func (*DataObjectEnricherResult) ProtoMessage

func (*DataObjectEnricherResult) ProtoMessage()

func (*DataObjectEnricherResult) ProtoReflect

func (x *DataObjectEnricherResult) ProtoReflect() protoreflect.Message

func (*DataObjectEnricherResult) Reset

func (x *DataObjectEnricherResult) Reset()

func (*DataObjectEnricherResult) String

func (x *DataObjectEnricherResult) String() string

type DataObjectEnricherServiceClient

type DataObjectEnricherServiceClient interface {
	CliVersionInformation(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*version.CliBuildInformation, error)
	Enrich(ctx context.Context, in *DataObjectEnricherConfig, opts ...grpc.CallOption) (*DataObjectEnricherResult, error)
}

DataObjectEnricherServiceClient is the client API for DataObjectEnricherService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewDataObjectEnricherServiceClient

func NewDataObjectEnricherServiceClient(cc grpc.ClientConnInterface) DataObjectEnricherServiceClient

type DataObjectEnricherServiceServer

type DataObjectEnricherServiceServer interface {
	CliVersionInformation(context.Context, *emptypb.Empty) (*version.CliBuildInformation, error)
	Enrich(context.Context, *DataObjectEnricherConfig) (*DataObjectEnricherResult, error)
	// contains filtered or unexported methods
}

DataObjectEnricherServiceServer is the server API for DataObjectEnricherService service. All implementations must embed UnimplementedDataObjectEnricherServiceServer for forward compatibility

type DataObjectEnricherVersionHandler

type DataObjectEnricherVersionHandler struct {
}

func (*DataObjectEnricherVersionHandler) CliVersionInformation

func (h *DataObjectEnricherVersionHandler) CliVersionInformation(ctx context.Context) (*version.CliBuildInformation, error)

type UnimplementedDataObjectEnricherServiceServer

type UnimplementedDataObjectEnricherServiceServer struct {
}

UnimplementedDataObjectEnricherServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedDataObjectEnricherServiceServer) CliVersionInformation

func (UnimplementedDataObjectEnricherServiceServer) CliVersionInformation(context.Context, *emptypb.Empty) (*version.CliBuildInformation, error)

func (UnimplementedDataObjectEnricherServiceServer) Enrich

func (UnimplementedDataObjectEnricherServiceServer) Enrich(context.Context, *DataObjectEnricherConfig) (*DataObjectEnricherResult, error)

type UnsafeDataObjectEnricherServiceServer

type UnsafeDataObjectEnricherServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDataObjectEnricherServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DataObjectEnricherServiceServer will result in compilation errors.