utils

Documentation

Index

• func ParseAddKeyRequestQueryString(r *http.Request) (isFlatten bool, err errors.EdgeX)
• func ParseDeleteKeyRequestQueryString(r *http.Request) (prefixMatch bool, err errors.EdgeX)
• func ParseGetKeyRequestQueryString(r *http.Request) (keysOnly bool, isRaw bool, err errors.EdgeX)
• func ParseQueryStringToBool(r *http.Request, queryStringKey string) (bool, errors.EdgeX)
• func ValidateKeys(key string) errors.EdgeX

Functions

func ParseAddKeyRequestQueryString

func ParseAddKeyRequestQueryString(r *http.Request) (isFlatten bool, err errors.EdgeX)

ParseAddKeyRequestQueryString parses flatten from the query parameters.

func ParseDeleteKeyRequestQueryString

func ParseDeleteKeyRequestQueryString(r *http.Request) (prefixMatch bool, err errors.EdgeX)

ParseDeleteKeyRequestQueryString parses prefixMatch from the query parameters.

func ParseGetKeyRequestQueryString

func ParseGetKeyRequestQueryString(r *http.Request) (keysOnly bool, isRaw bool, err errors.EdgeX)

ParseGetKeyRequestQueryString parses keyOnly and plaintext from the query parameters.

func ParseQueryStringToBool

func ParseQueryStringToBool(r *http.Request, queryStringKey string) (bool, errors.EdgeX)

ParseQueryStringToBool parses the specified query string key to a bool. If specified query string key is found more than once in the http request, only the first specified query string will be parsed and converted to a bool. If no specified query string key could be found in the http request, specified default value will be returned. EdgeX error will be returned if any parsing error occurs.

func ValidateKeys

func ValidateKeys(key string) errors.EdgeX

ValidateKeys validates if the key contains invalid characters