common

package
v4.0.0-dev.22 Latest Latest
Warning

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

 Go to latest Published: Jan 15, 2025 License: Apache-2.0 Imports: 9 Imported by: 22

Documentation

Index

Constants

View Source 
const (
	ApiVersion = "v3"
	ApiBase    = "/api/v3"

	ApiEventRoute                                           = ApiBase + "/event"
	ApiAllEventRoute                                        = ApiEventRoute + "/" + All
	ApiEventCountRoute                                      = ApiEventRoute + "/" + Count
	ApiEventServiceNameProfileNameDeviceNameSourceNameRoute = ApiEventRoute + "/:" + ServiceName + "/:" + ProfileName + "/:" + DeviceName + "/:" + SourceName
	ApiEventIdRoute                                         = ApiEventRoute + "/" + Id + "/:" + Id
	ApiEventCountByDeviceNameRoute                          = ApiEventCountRoute + "/" + Device + "/" + Name + "/:" + Name
	ApiEventByDeviceNameRoute                               = ApiEventRoute + "/" + Device + "/" + Name + "/:" + Name
	ApiEventByTimeRangeRoute                                = ApiEventRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
	ApiEventByAgeRoute                                      = ApiEventRoute + "/" + Age + "/:" + Age

	ApiReadingRoute                                        = ApiBase + "/reading"
	ApiAllReadingRoute                                     = ApiReadingRoute + "/" + All
	ApiReadingCountRoute                                   = ApiReadingRoute + "/" + Count
	ApiReadingCountByDeviceNameRoute                       = ApiReadingCountRoute + "/" + Device + "/" + Name + "/:" + Name
	ApiReadingByDeviceNameRoute                            = ApiReadingRoute + "/" + Device + "/" + Name + "/:" + Name
	ApiReadingByResourceNameRoute                          = ApiReadingRoute + "/" + ResourceName + "/:" + ResourceName
	ApiReadingByTimeRangeRoute                             = ApiReadingRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
	ApiReadingByResourceNameAndTimeRangeRoute              = ApiReadingByResourceNameRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
	ApiReadingByDeviceNameAndResourceNameRoute             = ApiReadingRoute + "/" + Device + "/" + Name + "/:" + Name + "/" + ResourceName + "/:" + ResourceName
	ApiReadingByDeviceNameAndResourceNameAndTimeRangeRoute = ApiReadingByDeviceNameAndResourceNameRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
	ApiReadingByDeviceNameAndTimeRangeRoute                = ApiReadingByDeviceNameRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End

	ApiDeviceProfileRoute                       = ApiBase + "/deviceprofile"
	ApiDeviceProfileBasicInfoRoute              = ApiDeviceProfileRoute + "/basicinfo"
	ApiAllDeviceProfileBasicInfoRoute           = ApiDeviceProfileBasicInfoRoute + "/" + All
	ApiDeviceProfileDeviceCommandRoute          = ApiDeviceProfileRoute + "/" + DeviceCommand
	ApiDeviceProfileResourceRoute               = ApiDeviceProfileRoute + "/" + Resource
	ApiDeviceProfileUploadFileRoute             = ApiDeviceProfileRoute + "/uploadfile"
	ApiAllDeviceProfileRoute                    = ApiDeviceProfileRoute + "/" + All
	ApiDeviceProfileByNameRoute                 = ApiDeviceProfileRoute + "/" + Name + "/:" + Name
	ApiDeviceProfileDeviceCommandByNameRoute    = ApiDeviceProfileByNameRoute + "/" + DeviceCommand + "/:" + CommandName
	ApiDeviceProfileResourceByNameRoute         = ApiDeviceProfileByNameRoute + "/" + Resource + "/:" + ResourceName
	ApiDeviceProfileByManufacturerRoute         = ApiDeviceProfileRoute + "/" + Manufacturer + "/:" + Manufacturer
	ApiDeviceProfileByModelRoute                = ApiDeviceProfileRoute + "/" + Model + "/:" + Model
	ApiDeviceProfileByManufacturerAndModelRoute = ApiDeviceProfileRoute + "/" + Manufacturer + "/:" + Manufacturer + "/" + Model + "/:" + Model

	ApiDeviceResourceRoute                     = ApiBase + "/deviceresource"
	ApiDeviceResourceByProfileAndResourceRoute = ApiDeviceResourceRoute + "/" + Profile + "/:" + ProfileName + "/" + Resource + "/:" + ResourceName

	ApiDeviceServiceRoute       = ApiBase + "/deviceservice"
	ApiAllDeviceServiceRoute    = ApiDeviceServiceRoute + "/" + All
	ApiDeviceServiceByNameRoute = ApiDeviceServiceRoute + "/" + Name + "/:" + Name

	ApiDeviceRoute                = ApiBase + "/device"
	ApiAllDeviceRoute             = ApiDeviceRoute + "/" + All
	ApiDeviceNameExistsRoute      = ApiDeviceRoute + "/" + Check + "/" + Name + "/:" + Name
	ApiDeviceByNameRoute          = ApiDeviceRoute + "/" + Name + "/:" + Name
	ApiDeviceByProfileNameRoute   = ApiDeviceRoute + "/" + Profile + "/" + Name + "/:" + Name
	ApiDeviceByServiceNameRoute   = ApiDeviceRoute + "/" + Service + "/" + Name + "/:" + Name
	ApiDeviceNameCommandNameRoute = ApiDeviceByNameRoute + "/:" + Command

	ApiProvisionWatcherRoute              = ApiBase + "/provisionwatcher"
	ApiAllProvisionWatcherRoute           = ApiProvisionWatcherRoute + "/" + All
	ApiProvisionWatcherByNameRoute        = ApiProvisionWatcherRoute + "/" + Name + "/:" + Name
	ApiProvisionWatcherByProfileNameRoute = ApiProvisionWatcherRoute + "/" + Profile + "/" + Name + "/:" + Name
	ApiProvisionWatcherByServiceNameRoute = ApiProvisionWatcherRoute + "/" + Service + "/" + Name + "/:" + Name

	ApiDiscoveryRoute     = ApiBase + "/discovery"
	ApiDiscoveryByIdRoute = ApiDiscoveryRoute + "/" + RequestId + "/:" + RequestId

	ApiProfileScanRoute             = ApiBase + "/profilescan"
	ApiProfileScanByDeviceNameRoute = ApiProfileScanRoute + "/" + Device + "/" + Name + "/:" + Name

	ApiSubscriptionRoute           = ApiBase + "/subscription"
	ApiAllSubscriptionRoute        = ApiSubscriptionRoute + "/" + All
	ApiSubscriptionByNameRoute     = ApiSubscriptionRoute + "/" + Name + "/:" + Name
	ApiSubscriptionByCategoryRoute = ApiSubscriptionRoute + "/" + Category + "/:" + Category
	ApiSubscriptionByLabelRoute    = ApiSubscriptionRoute + "/" + Label + "/:" + Label
	ApiSubscriptionByReceiverRoute = ApiSubscriptionRoute + "/" + Receiver + "/:" + Receiver

	ApiNotificationRoute                   = ApiBase + "/notification"
	ApiNotificationCleanupRoute            = ApiBase + "/cleanup"
	ApiNotificationCleanupByAgeRoute       = ApiNotificationCleanupRoute + "/" + Age + "/:" + Age
	ApiNotificationByTimeRangeRoute        = ApiNotificationRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
	ApiNotificationByAgeRoute              = ApiNotificationRoute + "/" + Age + "/:" + Age
	ApiNotificationByCategoryRoute         = ApiNotificationRoute + "/" + Category + "/:" + Category
	ApiNotificationByLabelRoute            = ApiNotificationRoute + "/" + Label + "/:" + Label
	ApiNotificationByIdRoute               = ApiNotificationRoute + "/" + Id + "/:" + Id
	ApiNotificationByIdsRoute              = ApiNotificationRoute + "/" + Ids + "/:" + Ids
	ApiNotificationByStatusRoute           = ApiNotificationRoute + "/" + Status + "/:" + Status
	ApiNotificationBySubscriptionNameRoute = ApiNotificationRoute + "/" + Subscription + "/" + Name + "/:" + Name
	ApiNotificationAcknowledgeByIdsRoute   = ApiNotificationRoute + "/" + Acknowledge + "/" + Ids + "/:" + Ids
	ApiNotificationUnacknowledgeByIdsRoute = ApiNotificationRoute + "/" + Unacknowledge + "/" + Ids + "/:" + Ids

	ApiTransmissionRoute                   = ApiBase + "/transmission"
	ApiAllTransmissionRoute                = ApiTransmissionRoute + "/" + All
	ApiTransmissionByIdRoute               = ApiTransmissionRoute + "/" + Id + "/:" + Id
	ApiTransmissionByAgeRoute              = ApiTransmissionRoute + "/" + Age + "/:" + Age
	ApiTransmissionBySubscriptionNameRoute = ApiTransmissionRoute + "/" + Subscription + "/" + Name + "/:" + Name
	ApiTransmissionByTimeRangeRoute        = ApiTransmissionRoute + "/" + Start + "/:" + Start + "/" + End + "/:" + End
	ApiTransmissionByStatusRoute           = ApiTransmissionRoute + "/" + Status + "/:" + Status
	ApiTransmissionByNotificationIdRoute   = ApiTransmissionRoute + "/" + Notification + "/" + Id + "/:" + Id

	ApiScheduleJobRoute              = ApiBase + "/job"
	ApiAllScheduleJobRoute           = ApiScheduleJobRoute + "/" + All
	ApiTriggerScheduleJobRoute       = ApiScheduleJobRoute + "/" + Trigger
	ApiScheduleJobByNameRoute        = ApiScheduleJobRoute + "/" + Name + "/:" + Name
	ApiTriggerScheduleJobByNameRoute = ApiTriggerScheduleJobRoute + "/" + Name + "/:" + Name

	ApiScheduleActionRecordRoute                        = ApiBase + "/scheduleactionrecord"
	ApiAllScheduleActionRecordRoute                     = ApiScheduleActionRecordRoute + "/" + All
	ApiLatestScheduleActionRecordByJobNameRoute         = ApiScheduleActionRecordRoute + "/" + Latest + "/" + Job + "/" + Name + "/:" + Name
	ApiScheduleActionRecordRouteByStatusRoute           = ApiScheduleActionRecordRoute + "/" + Status + "/:" + Status
	ApiScheduleActionRecordRouteByJobNameRoute          = ApiScheduleActionRecordRoute + "/" + Job + "/" + Name + "/:" + Name
	ApiScheduleActionRecordRouteByJobNameAndStatusRoute = ApiScheduleActionRecordRoute + "/" + Job + "/" + Name + "/:" + Name + "/" + Status + "/:" + Status

	ApiConfigRoute         = ApiBase + "/config"
	ApiPingRoute           = ApiBase + "/ping"
	ApiVersionRoute        = ApiBase + "/version"
	ApiSecretRoute         = ApiBase + "/secret"
	ApiUnitsOfMeasureRoute = ApiBase + "/uom"

	ApiSystemRoute      = ApiBase + "/system"
	ApiOperationRoute   = ApiSystemRoute + "/operation"
	ApiHealthRoute      = ApiSystemRoute + "/health"
	ApiMultiConfigRoute = ApiSystemRoute + "/config"

	ApiKVSRoute                     = ApiBase + "/kvs"
	ApiRegisterRoute                = ApiBase + "/registry"
	ApiAllRegistrationsRoute        = ApiRegisterRoute + "/" + All
	ApiKVSByKeyRoute                = ApiKVSRoute + "/" + Key + "/:" + Key
	ApiRegistrationByServiceIdRoute = ApiRegisterRoute + "/" + ServiceId + "/:" + ServiceId

	ApiKeyRoute                     = ApiBase + "/key"
	ApiVerificationKeyByIssuerRoute = ApiKeyRoute + "/" + VerificationKeyType + "/" + Issuer + "/:" + Issuer
)

Constants related to defined routes in the v3 service APIs

View Source 
const (
	All           = "all"
	Id            = "id"
	Ids           = "ids"
	Created       = "created"
	Modified      = "modified"
	Pushed        = "pushed"
	Origin        = "origin"
	Count         = "count"
	Device        = "device"
	DeviceId      = "deviceId"
	DeviceName    = "deviceName"
	DeviceCommand = "deviceCommand"
	Check         = "check"
	Profile       = "profile"
	Resource      = "resource"
	RequestId     = "requestId"
	Service       = "service"
	Services      = "services"
	Command       = "command"
	ProfileName   = "profileName"
	SourceName    = "sourceName"
	ServiceName   = "serviceName"
	ResourceName  = "resourceName"
	ResourceNames = "resourceNames"
	CommandName   = "commandName"
	Start         = "start"
	End           = "end"
	Age           = "age"
	Scrub         = "scrub"
	Type          = "type"
	Name          = "name"
	Label         = "label"
	Manufacturer  = "manufacturer"
	Model         = "model"
	ValueType     = "valueType"
	Category      = "category"
	Receiver      = "receiver"
	Subscription  = "subscription"
	Notification  = "notification"
	Target        = "target"
	Status        = "status"
	Cleanup       = "cleanup"
	Sender        = "sender"
	Severity      = "severity"
	Interval      = "interval"
	Key           = "key"
	ServiceId     = "serviceId"
	Job           = "job"
	Trigger       = "trigger"
	Latest        = "latest"
	Ack           = "ack"
	Acknowledge   = "acknowledge"
	Unacknowledge = "unacknowledge"

	Offset        = "offset"         //query string to specify the number of items to skip before starting to collect the result set.
	Limit         = "limit"          //query string to specify the numbers of items to return
	Labels        = "labels"         //query string to specify associated user-defined labels for querying a given object. More than one label may be specified via a comma-delimited list
	PushEvent     = "ds-pushevent"   //query string to specify if an event should be pushed to the EdgeX system
	ReturnEvent   = "ds-returnevent" //query string to specify if an event should be returned from device service
	RegexCommand  = "ds-regexcmd"    //query string to specify if the command name is in regular expression format
	DescendantsOf = "descendantsOf"  //Limit returned devices to those who have parent, grandparent, etc. of the given device name
	MaxLevels     = "maxLevels"      //Limit returned devices to this many levels below 'descendantsOf' (0=unlimited)
	Flatten       = "flatten"        //query string to specify if the request json payload should be flattened to update multiple keys with the same prefix
	KeyOnly       = "keyOnly"        //query string to specify if the response will only return the keys of the specified query key prefix, without values and metadata
	Plaintext     = "plaintext"      //query string to specify if the response will return the stored plain text value of the key(s) without any encoding
	Deregistered  = "deregistered"   //query string to specify if the response will return the registries of deregistered services
)

Constants related to defined url path names and parameters in the v3 service APIs

View Source 
const (
	DefaultOffset  = 0
	DefaultLimit   = 20
	CommaSeparator = ","
	ValueTrue      = "true"
	ValueFalse     = "false"
)

Constants related to the default value of query strings in the v3 service APIs

View Source 
const (
	ValueTypeBool         = "Bool"
	ValueTypeString       = "String"
	ValueTypeUint8        = "Uint8"
	ValueTypeUint16       = "Uint16"
	ValueTypeUint32       = "Uint32"
	ValueTypeUint64       = "Uint64"
	ValueTypeInt8         = "Int8"
	ValueTypeInt16        = "Int16"
	ValueTypeInt32        = "Int32"
	ValueTypeInt64        = "Int64"
	ValueTypeFloat32      = "Float32"
	ValueTypeFloat64      = "Float64"
	ValueTypeBinary       = "Binary"
	ValueTypeBoolArray    = "BoolArray"
	ValueTypeStringArray  = "StringArray"
	ValueTypeUint8Array   = "Uint8Array"
	ValueTypeUint16Array  = "Uint16Array"
	ValueTypeUint32Array  = "Uint32Array"
	ValueTypeUint64Array  = "Uint64Array"
	ValueTypeInt8Array    = "Int8Array"
	ValueTypeInt16Array   = "Int16Array"
	ValueTypeInt32Array   = "Int32Array"
	ValueTypeInt64Array   = "Int64Array"
	ValueTypeFloat32Array = "Float32Array"
	ValueTypeFloat64Array = "Float64Array"
	ValueTypeObject       = "Object"
	ValueTypeObjectArray  = "ObjectArray"
)

Constants related to Reading ValueTypes

View Source 
const (
	Primary  = "Primary"
	Password = "Password"
)

Constants related to configuration file's map key

View Source 
const (
	// Type
	REST   = "REST"
	MQTT   = "MQTT"
	EMAIL  = "EMAIL"
	ZeroMQ = "ZeroMQ"
	HTTP   = "http"
	TCP    = "tcp"
	TCPS   = "tcps"
)

Constants for Address

View Source 
const (
	ActionStart   = "start"
	ActionRestart = "restart"
	ActionStop    = "stop"
)

Constants for SMA Operation Action

View Source 
const (
	ReadWrite_R  = "R"
	ReadWrite_W  = "W"
	ReadWrite_RW = "RW"
	ReadWrite_WR = "WR"
)

Constants for DeviceProfile

View Source 
const (
	DefInterval           = "INTERVAL"
	DefCron               = "CRON"
	ActionEdgeXMessageBus = "EDGEXMESSAGEBUS"
	ActionREST            = "REST"
	ActionDeviceControl   = "DEVICECONTROL"
)

Constant for ScheduleJob

View Source 
const (
	ClientMonitorDefault = 15000              // Defaults the interval at which a given service client will refresh its endpoint from the Registry, if used
	CorrelationHeader    = "X-Correlation-ID" // Sets the key of the Correlation ID HTTP header
)

Miscellaneous constants

View Source 
const (
	CoreCommandServiceKey               = "core-command"
	CoreDataServiceKey                  = "core-data"
	CoreMetaDataServiceKey              = "core-metadata"
	CoreCommonConfigServiceKey          = "core-common-config-bootstrapper"
	CoreKeeperServiceKey                = "core-keeper"
	SupportLoggingServiceKey            = "support-logging"
	SupportNotificationsServiceKey      = "support-notifications"
	SupportSchedulerServiceKey          = "support-scheduler"
	SecuritySecretStoreSetupServiceKey  = "security-secretstore-setup"
	SecurityProxyAuthServiceKey         = "security-proxy-auth"
	SecurityProxySetupServiceKey        = "security-proxy-setup"
	SecurityFileTokenProviderServiceKey = "security-file-token-provider"
	SecurityBootstrapperKey             = "security-bootstrapper"
	SecurityBootstrapperPostgresKey     = "security-bootstrapper-postgres"
	SecurityBootstrapperRedisKey        = "security-bootstrapper-redis"
	SecuritySpiffeTokenProviderKey      = "security-spiffe-token-provider" // nolint:gosec
)

Constants related to how services identify themselves in the Service Registry

View Source 
const (
	Accept          = "Accept"
	ContentType     = "Content-Type"
	ContentLength   = "Content-Length"
	ContentTypeCBOR = "application/cbor"
	ContentTypeJSON = "application/json"
	ContentTypeTOML = "application/toml"
	ContentTypeYAML = "application/x-yaml"
	ContentTypeText = "text/plain"
	ContentTypeXML  = "application/xml"
)

Constants related to the possible content types supported by the APIs

View Source 
const (
	DeviceSystemEventType           = "device"
	DeviceProfileSystemEventType    = "deviceprofile"
	DeviceServiceSystemEventType    = "deviceservice"
	ProvisionWatcherSystemEventType = "provisionwatcher"
	SystemEventActionAdd            = "add"
	SystemEventActionUpdate         = "update"
	SystemEventActionDelete         = "delete"
	SystemEventActionDiscovery      = "discovery"
	SystemEventActionProfileScan    = "profilescan"
)

Constants related to System Events

View Source 
const (
	ConfigStemAll      = "edgex/v4" // Version never changes during minor releases so v3 is more appropriate than 3.0
	ConfigStemApp      = ConfigStemAll
	ConfigStemCore     = ConfigStemAll
	ConfigStemDevice   = ConfigStemAll
	ConfigStemSecurity = ConfigStemAll
)
View Source 
const (
	CommandQueryRequestTopicKey   = "CommandQueryRequestTopic" // #nosec G101
	CommandQueryResponseTopicKey  = "CommandQueryResponseTopic"
	CommandRequestTopicKey        = "CommandRequestTopic"
	CommandResponseTopicPrefixKey = "CommandResponseTopicPrefix"
)
View Source 
const (

	// Common Topics
	DefaultBaseTopic        = "edgex"         // Used if the base topic is not specified in MessageBus configuration
	EventsPublishTopic      = "events"        // <ServiceType>/<DeviceServiceName>/<ProfileName>/<DeviceName>/<SourceName> are appended
	ResponseTopic           = "response"      // <ServiceName>/<RequestId> are prepended
	MetricsPublishTopic     = "telemetry"     // <ServiceName>/<MetricName> are prepended
	SystemEventPublishTopic = "system-events" // <SourceServiceName>/<SystemEventType>/<SystemEventAction><OwnerServiceName>/<ProfileName>

	// Core Data Topics
	CoreDataEventSubscribeTopic = "events/device/#"

	// Core Command Topics
	CoreCommandDeviceRequestPublishTopic  = "device/command/request" // <DeviceServiceName>/<DeviceName>/<CommandName>/<CommandMethod> are appended
	CoreCommandRequestSubscribeTopic      = "core/command/request/#"
	CoreCommandQueryRequestSubscribeTopic = "core/commandquery/request/#"

	// Command Client Topics
	CoreCommandQueryRequestPublishTopic = "core/commandquery/request" // <deviceName>|all is prepended
	CoreCommandRequestPublishTopic      = "core/command/request"      // <DeviceName>/<CommandName>/<CommandMethod> are appended

	// Device Services Topics
	CommandRequestSubscribeTopic      = "device/command/request"          // <DeviceServiceName>/# is appended <
	MetadataSystemEventSubscribeTopic = "system-events/core-metadata/+/+" // <DeviceServiceName>/# is appended
	ValidateDeviceSubscribeTopic      = "validate/device"                 // <DeviceServiceName> is pre-pended

)

MessageBus Topics

View Source 
const (
	VerificationKeyType = "verification"
	SigningKeyType      = "signing"
	Issuer              = "issuer"
)

Constants related to the security-proxy-auth service

View Source 
const (
	EnvEncodeAllEvents = "EDGEX_ENCODE_ALL_EVENTS_CBOR"
)

Constants for Edgex Environment variable

Variables

This section is empty.

Functions

func BuildTopic 

func BuildTopic(parts ...string) string

BuildTopic is a helper function to build MessageBus topic from multiple parts

func NewPathBuilder 

func NewPathBuilder() *pathBuilder

func NormalizeValueType 

func NormalizeValueType(valueType string) (string, error)

NormalizeValueType normalizes the valueType to upper camel case

func StrSliceFromProperties 

func StrSliceFromProperties(key string, properties map[string]any) []string

StrSliceFromProperties retrieves a slice of strings associated with the given key from the provided properties map.

func StrValueFromProperties 

func StrValueFromProperties(key string, properties map[string]any) (val string)

StrValueFromProperties retrieves the string value associated with the given key from the provided properties map.

func URLEncode 

func URLEncode(s string) string

URLEncode encodes the input string with additional common character support

func Validate 

func Validate(a interface{}) error

Validate function will use the validator package to validate the struct annotation

func ValidateDtoNoReservedChars 

func ValidateDtoNoReservedChars(fl validator.FieldLevel) bool

ValidateDtoNoReservedChars used to check if DTO's name pointer value excludes reserved characters= / "/" / "#" / "." / "*" / "+" / "$"

func ValidateDtoNoneEmptyString 

func ValidateDtoNoneEmptyString(fl validator.FieldLevel) bool

ValidateDtoNoneEmptyString used to check the UpdateDTO name pointer value

func ValidateDtoPassword 

func ValidateDtoPassword(fl validator.FieldLevel) bool

ValidateDtoPassword used to check if DTO's password field contains at least 1 uppercase letter, 1 lowercase letter, 1 digit and 1 special character (one of @$!%*?&); the password length is 8 to 64 characters long

func ValidateDtoRFC3986UnreservedChars 

func ValidateDtoRFC3986UnreservedChars(fl validator.FieldLevel) bool

ValidateDtoRFC3986UnreservedChars used to check if DTO's name pointer value only contains unreserved characters as defined in https://tools.ietf.org/html/rfc3986#section-2.3

func ValidateDtoUsername 

func ValidateDtoUsername(fl validator.FieldLevel) bool

ValidateDtoUsername used to check if DTO's username field follows the usernameRegex rule

func ValidateDtoUuid 

func ValidateDtoUuid(fl validator.FieldLevel) bool

ValidateDtoUuid used to check the UpdateDTO uuid pointer value Currently, required_without can not correct work with other tag, so write custom tag instead. Issue can refer to https://github.com/go-playground/validator/issues/624

func ValidateDuration 

func ValidateDuration(fl validator.FieldLevel) bool

ValidateDuration validate field which should follow the ISO 8601 Durations format the min/max of the Duration can be set via the tag params ex. edgex-dto-duration=10ms0x2C24h - 10ms represents the minimum Duration and 24h represents the maximum Duration 0x2c is the UTF-8 hex encoding of comma (,) as the min/max value separator

func ValidateIntervalDatetime 

func ValidateIntervalDatetime(fl validator.FieldLevel) bool

ValidateIntervalDatetime validate Interval's datetime field which should follow the ISO 8601 format YYYYMMDD'T'HHmmss

func ValidateValueType 

func ValidateValueType(fl validator.FieldLevel) bool

ValidateValueType checks whether the valueType is valid

Types

This section is empty.

Source Files

View all Source files

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.