pluginextensionv2

package
v11.1.4-modfix Latest Latest
Warning

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

Go to latest
Published: Aug 20, 2024 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Renderer_Render_FullMethodName    = "/pluginextensionv2.Renderer/Render"
	Renderer_RenderCSV_FullMethodName = "/pluginextensionv2.Renderer/RenderCSV"
)
View Source
const (
	Sanitizer_Sanitize_FullMethodName = "/pluginextensionv2.Sanitizer/Sanitize"
)

Variables

View Source
var File_rendererv2_proto protoreflect.FileDescriptor
View Source
var File_sanitizer_proto protoreflect.FileDescriptor
View Source
var Renderer_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pluginextensionv2.Renderer",
	HandlerType: (*RendererServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Render",
			Handler:    _Renderer_Render_Handler,
		},
		{
			MethodName: "RenderCSV",
			Handler:    _Renderer_RenderCSV_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "rendererv2.proto",
}

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

View Source
var Sanitizer_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pluginextensionv2.Sanitizer",
	HandlerType: (*SanitizerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Sanitize",
			Handler:    _Sanitizer_Sanitize_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "sanitizer.proto",
}

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

Functions

func RegisterRendererServer

func RegisterRendererServer(s grpc.ServiceRegistrar, srv RendererServer)

func RegisterSanitizerServer

func RegisterSanitizerServer(s grpc.ServiceRegistrar, srv SanitizerServer)

Types

type RenderCSVRequest

type RenderCSVRequest struct {
	Url       string                 `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	FilePath  string                 `protobuf:"bytes,2,opt,name=filePath,proto3" json:"filePath,omitempty"`
	RenderKey string                 `protobuf:"bytes,3,opt,name=renderKey,proto3" json:"renderKey,omitempty"`
	Domain    string                 `protobuf:"bytes,4,opt,name=domain,proto3" json:"domain,omitempty"`
	Timeout   int32                  `protobuf:"varint,5,opt,name=timeout,proto3" json:"timeout,omitempty"`
	Timezone  string                 `protobuf:"bytes,6,opt,name=timezone,proto3" json:"timezone,omitempty"`
	Headers   map[string]*StringList `` /* 155-byte string literal not displayed */
	AuthToken string                 `protobuf:"bytes,8,opt,name=authToken,proto3" json:"authToken,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderCSVRequest) Descriptor deprecated

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

Deprecated: Use RenderCSVRequest.ProtoReflect.Descriptor instead.

func (*RenderCSVRequest) GetAuthToken

func (x *RenderCSVRequest) GetAuthToken() string

func (*RenderCSVRequest) GetDomain

func (x *RenderCSVRequest) GetDomain() string

func (*RenderCSVRequest) GetFilePath

func (x *RenderCSVRequest) GetFilePath() string

func (*RenderCSVRequest) GetHeaders

func (x *RenderCSVRequest) GetHeaders() map[string]*StringList

func (*RenderCSVRequest) GetRenderKey

func (x *RenderCSVRequest) GetRenderKey() string

func (*RenderCSVRequest) GetTimeout

func (x *RenderCSVRequest) GetTimeout() int32

func (*RenderCSVRequest) GetTimezone

func (x *RenderCSVRequest) GetTimezone() string

func (*RenderCSVRequest) GetUrl

func (x *RenderCSVRequest) GetUrl() string

func (*RenderCSVRequest) ProtoMessage

func (*RenderCSVRequest) ProtoMessage()

func (*RenderCSVRequest) ProtoReflect

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

func (*RenderCSVRequest) Reset

func (x *RenderCSVRequest) Reset()

func (*RenderCSVRequest) String

func (x *RenderCSVRequest) String() string

type RenderCSVResponse

type RenderCSVResponse struct {
	Error    string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	FileName string `protobuf:"bytes,2,opt,name=fileName,proto3" json:"fileName,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderCSVResponse) Descriptor deprecated

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

Deprecated: Use RenderCSVResponse.ProtoReflect.Descriptor instead.

func (*RenderCSVResponse) GetError

func (x *RenderCSVResponse) GetError() string

func (*RenderCSVResponse) GetFileName

func (x *RenderCSVResponse) GetFileName() string

func (*RenderCSVResponse) ProtoMessage

func (*RenderCSVResponse) ProtoMessage()

func (*RenderCSVResponse) ProtoReflect

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

func (*RenderCSVResponse) Reset

func (x *RenderCSVResponse) Reset()

func (*RenderCSVResponse) String

func (x *RenderCSVResponse) String() string

type RenderRequest

type RenderRequest struct {
	Url               string                 `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	Width             int32                  `protobuf:"varint,2,opt,name=width,proto3" json:"width,omitempty"`
	Height            int32                  `protobuf:"varint,3,opt,name=height,proto3" json:"height,omitempty"`
	DeviceScaleFactor float32                `protobuf:"fixed32,4,opt,name=deviceScaleFactor,proto3" json:"deviceScaleFactor,omitempty"`
	FilePath          string                 `protobuf:"bytes,5,opt,name=filePath,proto3" json:"filePath,omitempty"`
	RenderKey         string                 `protobuf:"bytes,6,opt,name=renderKey,proto3" json:"renderKey,omitempty"`
	Domain            string                 `protobuf:"bytes,7,opt,name=domain,proto3" json:"domain,omitempty"`
	Timeout           int32                  `protobuf:"varint,8,opt,name=timeout,proto3" json:"timeout,omitempty"`
	Timezone          string                 `protobuf:"bytes,9,opt,name=timezone,proto3" json:"timezone,omitempty"`
	Headers           map[string]*StringList `` /* 156-byte string literal not displayed */
	AuthToken         string                 `protobuf:"bytes,11,opt,name=authToken,proto3" json:"authToken,omitempty"`
	Encoding          string                 `protobuf:"bytes,12,opt,name=encoding,proto3" json:"encoding,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderRequest) Descriptor deprecated

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

Deprecated: Use RenderRequest.ProtoReflect.Descriptor instead.

func (*RenderRequest) GetAuthToken

func (x *RenderRequest) GetAuthToken() string

func (*RenderRequest) GetDeviceScaleFactor

func (x *RenderRequest) GetDeviceScaleFactor() float32

func (*RenderRequest) GetDomain

func (x *RenderRequest) GetDomain() string

func (*RenderRequest) GetEncoding

func (x *RenderRequest) GetEncoding() string

func (*RenderRequest) GetFilePath

func (x *RenderRequest) GetFilePath() string

func (*RenderRequest) GetHeaders

func (x *RenderRequest) GetHeaders() map[string]*StringList

func (*RenderRequest) GetHeight

func (x *RenderRequest) GetHeight() int32

func (*RenderRequest) GetRenderKey

func (x *RenderRequest) GetRenderKey() string

func (*RenderRequest) GetTimeout

func (x *RenderRequest) GetTimeout() int32

func (*RenderRequest) GetTimezone

func (x *RenderRequest) GetTimezone() string

func (*RenderRequest) GetUrl

func (x *RenderRequest) GetUrl() string

func (*RenderRequest) GetWidth

func (x *RenderRequest) GetWidth() int32

func (*RenderRequest) ProtoMessage

func (*RenderRequest) ProtoMessage()

func (*RenderRequest) ProtoReflect

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

func (*RenderRequest) Reset

func (x *RenderRequest) Reset()

func (*RenderRequest) String

func (x *RenderRequest) String() string

type RenderResponse

type RenderResponse struct {
	Error string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*RenderResponse) Descriptor deprecated

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

Deprecated: Use RenderResponse.ProtoReflect.Descriptor instead.

func (*RenderResponse) GetError

func (x *RenderResponse) GetError() string

func (*RenderResponse) ProtoMessage

func (*RenderResponse) ProtoMessage()

func (*RenderResponse) ProtoReflect

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

func (*RenderResponse) Reset

func (x *RenderResponse) Reset()

func (*RenderResponse) String

func (x *RenderResponse) String() string

type RendererClient

type RendererClient interface {
	Render(ctx context.Context, in *RenderRequest, opts ...grpc.CallOption) (*RenderResponse, error)
	RenderCSV(ctx context.Context, in *RenderCSVRequest, opts ...grpc.CallOption) (*RenderCSVResponse, error)
}

RendererClient is the client API for Renderer 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 NewRendererClient

func NewRendererClient(cc grpc.ClientConnInterface) RendererClient

type RendererGRPCClient

type RendererGRPCClient struct {
	RendererClient
	SanitizerClient
}

func (*RendererGRPCClient) Render

func (*RendererGRPCClient) Sanitize

type RendererGRPCPlugin

type RendererGRPCPlugin struct {
	plugin.NetRPCUnsupportedPlugin
}

func (*RendererGRPCPlugin) GRPCClient

func (p *RendererGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (any, error)

func (*RendererGRPCPlugin) GRPCServer

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

type RendererPlugin

type RendererPlugin interface {
	RendererClient
	SanitizerClient
}

type RendererServer

type RendererServer interface {
	Render(context.Context, *RenderRequest) (*RenderResponse, error)
	RenderCSV(context.Context, *RenderCSVRequest) (*RenderCSVResponse, error)
	// contains filtered or unexported methods
}

RendererServer is the server API for Renderer service. All implementations must embed UnimplementedRendererServer for forward compatibility

type SanitizeRequest

type SanitizeRequest struct {
	Filename   string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	Content    []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	ConfigType string `protobuf:"bytes,3,opt,name=configType,proto3" json:"configType,omitempty"` // DOMPurify, ...
	Config     []byte `protobuf:"bytes,4,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*SanitizeRequest) Descriptor deprecated

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

Deprecated: Use SanitizeRequest.ProtoReflect.Descriptor instead.

func (*SanitizeRequest) GetConfig

func (x *SanitizeRequest) GetConfig() []byte

func (*SanitizeRequest) GetConfigType

func (x *SanitizeRequest) GetConfigType() string

func (*SanitizeRequest) GetContent

func (x *SanitizeRequest) GetContent() []byte

func (*SanitizeRequest) GetFilename

func (x *SanitizeRequest) GetFilename() string

func (*SanitizeRequest) ProtoMessage

func (*SanitizeRequest) ProtoMessage()

func (*SanitizeRequest) ProtoReflect

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

func (*SanitizeRequest) Reset

func (x *SanitizeRequest) Reset()

func (*SanitizeRequest) String

func (x *SanitizeRequest) String() string

type SanitizeResponse

type SanitizeResponse struct {
	Error     string `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	Sanitized []byte `protobuf:"bytes,2,opt,name=sanitized,proto3" json:"sanitized,omitempty"`
	// contains filtered or unexported fields
}

func (*SanitizeResponse) Descriptor deprecated

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

Deprecated: Use SanitizeResponse.ProtoReflect.Descriptor instead.

func (*SanitizeResponse) GetError

func (x *SanitizeResponse) GetError() string

func (*SanitizeResponse) GetSanitized

func (x *SanitizeResponse) GetSanitized() []byte

func (*SanitizeResponse) ProtoMessage

func (*SanitizeResponse) ProtoMessage()

func (*SanitizeResponse) ProtoReflect

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

func (*SanitizeResponse) Reset

func (x *SanitizeResponse) Reset()

func (*SanitizeResponse) String

func (x *SanitizeResponse) String() string

type SanitizerClient

type SanitizerClient interface {
	Sanitize(ctx context.Context, in *SanitizeRequest, opts ...grpc.CallOption) (*SanitizeResponse, error)
}

SanitizerClient is the client API for Sanitizer 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 NewSanitizerClient

func NewSanitizerClient(cc grpc.ClientConnInterface) SanitizerClient

type SanitizerServer

type SanitizerServer interface {
	Sanitize(context.Context, *SanitizeRequest) (*SanitizeResponse, error)
	// contains filtered or unexported methods
}

SanitizerServer is the server API for Sanitizer service. All implementations must embed UnimplementedSanitizerServer for forward compatibility

type StringList

type StringList struct {
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*StringList) Descriptor deprecated

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

Deprecated: Use StringList.ProtoReflect.Descriptor instead.

func (*StringList) GetValues

func (x *StringList) GetValues() []string

func (*StringList) ProtoMessage

func (*StringList) ProtoMessage()

func (*StringList) ProtoReflect

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

func (*StringList) Reset

func (x *StringList) Reset()

func (*StringList) String

func (x *StringList) String() string

type UnimplementedRendererServer

type UnimplementedRendererServer struct {
}

UnimplementedRendererServer must be embedded to have forward compatible implementations.

func (UnimplementedRendererServer) Render

func (UnimplementedRendererServer) RenderCSV

type UnimplementedSanitizerServer

type UnimplementedSanitizerServer struct {
}

UnimplementedSanitizerServer must be embedded to have forward compatible implementations.

func (UnimplementedSanitizerServer) Sanitize

type UnsafeRendererServer

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

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

type UnsafeSanitizerServer

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL