# README
ThreatWinds Go SDK
# Packages
No description provided by the author
# Functions
CastBool attempts to cast an interface{} to a bool.
CastFloat64 attempts to cast an interface{} to a float64.
CastInt64 attempts to cast a given interface{} value to an int64.
CastString attempts to cast an interface{} to a string.
DoReq sends an HTTP request and processes the response.
Download downloads the content from the specified URL and saves it to the specified file.
EnqueueNotification sends a notification message to a specified topic.
Error tries to cast the cause as an SdkError, if it is not an SdkError, it creates a new SdkError with the given parameters.
GetCelType returns a pointer to a cel.Type based on the provided string type identifier.
GetCfg initializes the configuration if it hasn't been initialized yet, and starts a goroutine to periodically update the configuration every 60 seconds.
GetMainIP retrieves the main IP address of the local machine by establishing a UDP connection to a remote server (Google's public DNS server in this case).
GetValueOf returns the Go representation of a gjson.Result value.
ListFiles walks through the directory specified by the route and returns a slice of file paths that match the given filter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewMeter creates a new Meter instance to measure the execution time of a function.
No description provided by the author
No description provided by the author
No description provided by the author
PluginCfg retrieves the configuration for a specified plugin by name and unmarshal it into the provided type.
PointerOf takes a value of any type and returns a pointer to that value.
ReadCSV reads a CSV file from the given URL and returns its contents as a slice of string slices.
ReadJSON reads a JSON file and parses its content into a specified type.
ReadPbYaml reads a YAML file, converts its content to JSON, and returns the JSON bytes.
ReadYaml reads a YAML file and converts its content into a specified type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SendNotificationsFromChannel listens to the notificationsChannel and sends notifications to the engine server via gRPC.
ToObject parses a JSON-encoded string into a given ProtoMessage object.
ToSdkError tries to cast an error to a SdkError.
ToString converts a given ProtoMessage object to its JSON string representation.
ValidateFilePath validates the file path to ensure it does not contain any invalid characters or directory traversal attempts.
ValidateReservedField validates a field to ensure it is not empty or a reserved field.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TOPIC_ANALYSIS_FAILURE represents the topic name for analysis failure notifications.
TOPIC_CEL_EVALUATION_FAILURE represents the topic name for CEL evaluation failure notifications.
TOPIC_CORRELATION_FAILURE represents the topic name for correlation failure notifications.
TOPIC_ENQUEUE_FAILURE represents the topic name for enqueue failure notifications.
TOPIC_ENQUEUE_SUCCESS represents the topic name for enqueue success notifications.
TOPIC_INTEGRATION_FAILURE represents the topic name for integration failure notifications.
TOPIC_OUTGOING_REQUEST_FAILURE represents the topic name for outgoing request failure notifications.
TOPIC_PARSING_FAILURE represents the topic name for parsing failure notifications.
# Variables
Analysis_ServiceDesc is the grpc.ServiceDesc for Analysis service.
Correlation_ServiceDesc is the grpc.ServiceDesc for Correlation service.
Engine_ServiceDesc is the grpc.ServiceDesc for Engine service.
No description provided by the author
Integration_ServiceDesc is the grpc.ServiceDesc for Integration service.
Notification_ServiceDesc is the grpc.ServiceDesc for Notification service.
No description provided by the author
No description provided by the author
Output_ServiceDesc is the grpc.ServiceDesc for Output service.
Parsing_ServiceDesc is the grpc.ServiceDesc for Parsing service.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DataProcessingMessage represent the details of a success or failure during the processing of a log.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Meter represents a structure to measure the execution time of a function.
MeterOptions defines the configuration options for metering.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SdkError is a struct that implements the Go error interface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedAnalysisServer must be embedded to have forward compatible implementations.
UnimplementedCorrelationServer must be embedded to have forward compatible implementations.
UnimplementedEngineServer must be embedded to have forward compatible implementations.
UnimplementedIntegrationServer must be embedded to have forward compatible implementations.
UnimplementedNotificationServer must be embedded to have forward compatible implementations.
UnimplementedOutputServer must be embedded to have forward compatible implementations.
UnimplementedParsingServer must be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
# Interfaces
AnalysisClient is the client API for Analysis service.
AnalysisServer is the server API for Analysis service.
CorrelationClient is the client API for Correlation service.
CorrelationServer is the server API for Correlation service.
EngineClient is the client API for Engine service.
EngineServer is the server API for Engine service.
IntegrationClient is the client API for Integration service.
IntegrationServer is the server API for Integration service.
NotificationClient is the client API for Notification service.
NotificationServer is the server API for Notification service.
OutputClient is the client API for Output service.
OutputServer is the server API for Output service.
ParsingClient is the client API for Parsing service.
ParsingServer is the server API for Parsing service.
UnsafeAnalysisServer may be embedded to opt out of forward compatibility for this service.
UnsafeCorrelationServer may be embedded to opt out of forward compatibility for this service.
UnsafeEngineServer may be embedded to opt out of forward compatibility for this service.
UnsafeIntegrationServer may be embedded to opt out of forward compatibility for this service.
UnsafeNotificationServer may be embedded to opt out of forward compatibility for this service.
UnsafeOutputServer may be embedded to opt out of forward compatibility for this service.
UnsafeParsingServer may be embedded to opt out of forward compatibility for this service.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author