package
4.0.0-dev.22
Repository: https://github.com/edgexfoundry/go-mod-core-contracts.git
Documentation: pkg.go.dev

# Functions

BuildTopic is a helper function to build MessageBus topic from multiple parts.
No description provided by the author
NormalizeValueType normalizes the valueType to upper camel case.
StrSliceFromProperties retrieves a slice of strings associated with the given key from the provided properties map.
StrValueFromProperties retrieves the string value associated with the given key from the provided properties map.
URLEncode encodes the input string with additional common character support.
Validate function will use the validator package to validate the struct annotation.
ValidateDtoNoneEmptyString used to check the UpdateDTO name pointer value.
ValidateDtoNoReservedChars used to check if DTO's name pointer value excludes reserved characters= / "/" / "#" / "." / "*" / "+" / "$".
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.
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.
ValidateDtoUsername used to check if DTO's username field follows the usernameRegex rule.
ValidateDtoUuid used to check the UpdateDTO uuid pointer value Currently, required_without can not correct work with other tag, so write custom tag instead.
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.
ValidateIntervalDatetime validate Interval's datetime field which should follow the ISO 8601 format YYYYMMDD'T'HHmmss.
ValidateValueType checks whether the valueType is valid.

# Constants

Constants related to the possible content types supported by the APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constant for ScheduleJob.
Constant for ScheduleJob.
Constant for ScheduleJob.
Constants for SMA Operation Action.
Constants for SMA Operation Action.
Constants for SMA Operation Action.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined routes in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Defaults the interval at which a given service client will refresh its endpoint from the Registry, if used.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
#nosec G101.
No description provided by the author
<DeviceServiceName>/# is appended <.
No description provided by the author
No description provided by the author
Constants related to the default value of query strings in the v3 service APIs.
Version never changes during minor releases so v3 is more appropriate than 3.0.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
Constants related to the possible content types supported by the APIs.
<DeviceServiceName>/<DeviceName>/<CommandName>/<CommandMethod> are appended.
<deviceName>|all is prepended.
MessageBus Topics.
<DeviceName>/<CommandName>/<CommandMethod> are appended.
MessageBus Topics.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Core Data Topics.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Sets the key of the Correlation ID HTTP header.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Used if the base topic is not specified in MessageBus configuration.
Constants related to the default value of query strings in the v3 service APIs.
Constants related to the default value of query strings in the v3 service APIs.
Constant for ScheduleJob.
Constant for ScheduleJob.
query string to specify if the response will return the registries of deregistered services.
Limit returned devices to those who have parent, grandparent, etc.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to System Events.
Constants related to System Events.
Constants related to System Events.
Constants for Address.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants for Edgex Environment variable.
<ServiceType>/<DeviceServiceName>/<ProfileName>/<DeviceName>/<SourceName> are appended.
query string to specify if the request json payload should be flattened to update multiple keys with the same prefix.
Constants for Address.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to the security-proxy-auth service.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
query string to specify if the response will only return the keys of the specified query key prefix, without values and metadata.
Constants related to defined url path names and parameters in the v3 service APIs.
query string to specify associated user-defined labels for querying a given object.
Constants related to defined url path names and parameters in the v3 service APIs.
query string to specify the numbers of items to return.
Constants related to defined url path names and parameters in the v3 service APIs.
Limit returned devices to this many levels below 'descendantsOf' (0=unlimited).
<DeviceServiceName>/# is appended.
<ServiceName>/<MetricName> are prepended.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants for Address.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
query string to specify the number of items to skip before starting to collect the result set.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to configuration file's map key.
query string to specify if the response will return the stored plain text value of the key(s) without any encoding.
Constants related to configuration file's map key.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to System Events.
Constants related to defined url path names and parameters in the v3 service APIs.
query string to specify if an event should be pushed to the EdgeX system.
Constants for DeviceProfile.
Constants for DeviceProfile.
Constants for DeviceProfile.
Constants for DeviceProfile.
Constants related to defined url path names and parameters in the v3 service APIs.
query string to specify if the command name is in regular expression format.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
<ServiceName>/<RequestId> are prepended.
Type.
query string to specify if an event should be returned from device service.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
nolint:gosec.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to the security-proxy-auth service.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to how services identify themselves in the Service Registry.
Constants related to System Events.
Constants related to System Events.
Constants related to System Events.
Constants related to System Events.
Constants related to System Events.
<SourceServiceName>/<SystemEventType>/<SystemEventAction><OwnerServiceName>/<ProfileName>.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants for Address.
Constants for Address.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
<DeviceServiceName> is pre-pended.
Constants related to the default value of query strings in the v3 service APIs.
Constants related to the default value of query strings in the v3 service APIs.
Constants related to defined url path names and parameters in the v3 service APIs.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to Reading ValueTypes.
Constants related to the security-proxy-auth service.
Constants for Address.