config

Documentation

Index

• Variables
• func EncodeReportingPluginConfig(rpConfig *ReportingPluginConfigWrapper) ([]byte, error)
• func ValidatePluginConfig(config PluginConfig) error
• type AggregationMethod
  • func (AggregationMethod) Descriptor() protoreflect.EnumDescriptor
  • func (x AggregationMethod) Enum() *AggregationMethod
  • func (AggregationMethod) EnumDescriptor() ([]byte, []int)
  • func (x AggregationMethod) Number() protoreflect.EnumNumber
  • func (x AggregationMethod) String() string
  • func (AggregationMethod) Type() protoreflect.EnumType
• type PluginConfig
• type ReportingPluginConfig
  • func (*ReportingPluginConfig) Descriptor() ([]byte, []int)
  • func (x *ReportingPluginConfig) GetDefaultAggregationMethod() AggregationMethod
  • func (x *ReportingPluginConfig) GetMaxObservationLengthBytes() uint32
  • func (x *ReportingPluginConfig) GetMaxQueryLengthBytes() uint32
  • func (x *ReportingPluginConfig) GetMaxReportLengthBytes() uint32
  • func (x *ReportingPluginConfig) GetMaxRequestBatchSize() uint32
  • func (x *ReportingPluginConfig) GetUniqueReports() bool
  • func (*ReportingPluginConfig) ProtoMessage()
  • func (x *ReportingPluginConfig) ProtoReflect() protoreflect.Message
  • func (x *ReportingPluginConfig) Reset()
  • func (x *ReportingPluginConfig) String() string
• type ReportingPluginConfigWrapper
  • func DecodeReportingPluginConfig(raw []byte) (*ReportingPluginConfigWrapper, error)

Variables

var (
	AggregationMethod_name = map[int32]string{
		0: "AGGREGATION_MODE",
		1: "AGGREGATION_MEDIAN",
	}
	AggregationMethod_value = map[string]int32{
		"AGGREGATION_MODE":   0,
		"AGGREGATION_MEDIAN": 1,
	}
)

Enum value maps for AggregationMethod.

var File_core_services_ocr2_plugins_functions_config_config_types_proto protoreflect.FileDescriptor

Functions

func EncodeReportingPluginConfig

func EncodeReportingPluginConfig(rpConfig *ReportingPluginConfigWrapper) ([]byte, error)

func ValidatePluginConfig

func ValidatePluginConfig(config PluginConfig) error

Types

type AggregationMethod

type AggregationMethod int32

const (
	AggregationMethod_AGGREGATION_MODE   AggregationMethod = 0
	AggregationMethod_AGGREGATION_MEDIAN AggregationMethod = 1
)

func (AggregationMethod) Descriptor

func (AggregationMethod) Descriptor() protoreflect.EnumDescriptor

func (AggregationMethod) Enum

func (x AggregationMethod) Enum() *AggregationMethod

func (AggregationMethod) EnumDescriptor

func (AggregationMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use AggregationMethod.Descriptor instead.

func (AggregationMethod) Number

func (x AggregationMethod) Number() protoreflect.EnumNumber

func (AggregationMethod) String

func (x AggregationMethod) String() string

func (AggregationMethod) Type

func (AggregationMethod) Type() protoreflect.EnumType

type PluginConfig

type PluginConfig struct {
	MinIncomingConfirmations        uint32 `json:"minIncomingConfirmations"`
	RequestTimeoutSec               uint32 `json:"requestTimeoutSec"`
	RequestTimeoutCheckFrequencySec uint32 `json:"requestTimeoutCheckFrequencySec"`
	RequestTimeoutBatchLookupSize   uint32 `json:"requestTimeoutBatchLookupSize"`
	ListenerEventHandlerTimeoutSec  uint32 `json:"listenerEventHandlerTimeoutSec"`
	MaxRequestSizeBytes             uint32 `json:"maxRequestSizeBytes"`
}

This config is part of the job spec and is loaded only once on node boot/job creation.

type ReportingPluginConfig

type ReportingPluginConfig struct {
	MaxQueryLengthBytes       uint32            `protobuf:"varint,1,opt,name=maxQueryLengthBytes,proto3" json:"maxQueryLengthBytes,omitempty"`
	MaxObservationLengthBytes uint32            `protobuf:"varint,2,opt,name=maxObservationLengthBytes,proto3" json:"maxObservationLengthBytes,omitempty"`
	MaxReportLengthBytes      uint32            `protobuf:"varint,3,opt,name=maxReportLengthBytes,proto3" json:"maxReportLengthBytes,omitempty"`
	MaxRequestBatchSize       uint32            `protobuf:"varint,4,opt,name=maxRequestBatchSize,proto3" json:"maxRequestBatchSize,omitempty"`
	DefaultAggregationMethod  AggregationMethod `` /* 138-byte string literal not displayed */
	UniqueReports             bool              `protobuf:"varint,6,opt,name=uniqueReports,proto3" json:"uniqueReports,omitempty"`
	// contains filtered or unexported fields
}

func (*ReportingPluginConfig) Descriptor

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

Deprecated: Use ReportingPluginConfig.ProtoReflect.Descriptor instead.

func (*ReportingPluginConfig) GetDefaultAggregationMethod

func (x *ReportingPluginConfig) GetDefaultAggregationMethod() AggregationMethod

func (*ReportingPluginConfig) GetMaxObservationLengthBytes

func (x *ReportingPluginConfig) GetMaxObservationLengthBytes() uint32

func (*ReportingPluginConfig) GetMaxQueryLengthBytes

func (x *ReportingPluginConfig) GetMaxQueryLengthBytes() uint32

func (*ReportingPluginConfig) GetMaxReportLengthBytes

func (x *ReportingPluginConfig) GetMaxReportLengthBytes() uint32

func (*ReportingPluginConfig) GetMaxRequestBatchSize

func (x *ReportingPluginConfig) GetMaxRequestBatchSize() uint32

func (*ReportingPluginConfig) GetUniqueReports

func (x *ReportingPluginConfig) GetUniqueReports() bool

func (*ReportingPluginConfig) ProtoMessage

func (*ReportingPluginConfig) ProtoMessage()

func (*ReportingPluginConfig) ProtoReflect

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

func (*ReportingPluginConfig) Reset

func (x *ReportingPluginConfig) Reset()

func (*ReportingPluginConfig) String

func (x *ReportingPluginConfig) String() string

type ReportingPluginConfigWrapper

type ReportingPluginConfigWrapper struct {
	Config *ReportingPluginConfig
}

This config is stored in the Oracle contract (set via SetConfig()). Every SetConfig() call reloads the reporting plugin (FunctionsReportingPluginFactory.NewReportingPlugin())

func DecodeReportingPluginConfig

func DecodeReportingPluginConfig(raw []byte) (*ReportingPluginConfigWrapper, error)