metadata

Documentation

Index

• Constants
• func DecodeMetadata(input interface{}, result interface{}) error
• func GetMetadataInfoFromStructType(t reflect.Type, metadataMap *map[string]string) error
• func GetMetadataProperty(props map[string]string, keys ...string) (val string, ok bool)
• func IsRawPayload(props map[string]string) (bool, error)
• func TryGetContentType(props map[string]string) (string, bool)
• func TryGetPriority(props map[string]string) (uint8, bool, error)
• func TryGetQueryIndexName(props map[string]string) (string, bool)
• func TryGetTTL(props map[string]string) (time.Duration, bool, error)
• type Base
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d Duration) ToISOString() string
  • func (d *Duration) UnmarshalJSON(b []byte) error

Constants

const (
	// TTLMetadataKey defines the metadata key for setting a time to live (in seconds).
	TTLMetadataKey = "ttlInSeconds"

	// RawPayloadKey defines the metadata key for forcing raw payload in pubsub.
	RawPayloadKey = "rawPayload"

	// PriorityMetadataKey defines the metadata key for setting a priority.
	PriorityMetadataKey = "priority"

	// ContentType defines the metadata key for the content type.
	ContentType = "contentType"

	// QueryIndexName defines the metadata key for the name of query indexing schema (for redis).
	QueryIndexName = "queryIndexName"

	// MaxBulkPubBytesKey defines the maximum bytes to publish in a bulk publish request metadata.
	MaxBulkPubBytesKey string = "maxBulkPubBytes"
)

Functions

func DecodeMetadata

func DecodeMetadata(input interface{}, result interface{}) error

DecodeMetadata decodes metadata into a struct This is an extension of mitchellh/mapstructure which also supports decoding durations

func GetMetadataInfoFromStructType

func GetMetadataInfoFromStructType(t reflect.Type, metadataMap *map[string]string) error

GetMetadataInfoFromStructType converts a struct to a map of field name (or struct tag) to field type. This is used to generate metadata documentation for components.

func GetMetadataProperty

func GetMetadataProperty(props map[string]string, keys ...string) (val string, ok bool)

GetMetadataProperty returns a property from the metadata map, with support for aliases

func IsRawPayload

func IsRawPayload(props map[string]string) (bool, error)

IsRawPayload determines if payload should be used as-is.

func TryGetContentType

func TryGetContentType(props map[string]string) (string, bool)

func TryGetPriority

func TryGetPriority(props map[string]string) (uint8, bool, error)

TryGetPriority tries to get the priority for binding and any other building block.

func TryGetQueryIndexName

func TryGetQueryIndexName(props map[string]string) (string, bool)

func TryGetTTL

func TryGetTTL(props map[string]string) (time.Duration, bool, error)

TryGetTTL tries to get the ttl as a time.Duration value for pubsub, binding and any other building block.

Types

type Base

type Base struct {
	// Name is the name of the component that's being used.
	Name string
	// Properties is the metadata properties.
	Properties map[string]string `json:"properties,omitempty"`
}

Base is the common metadata across components. All components-specific metadata should embed this.

type Duration

type Duration struct {
	time.Duration
}

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

func (Duration) ToISOString

func (d Duration) ToISOString() string

ToISOString returns the duration formatted as a ISO-8601 duration string (-ish). This methods supports days, hours, minutes, and seconds. It assumes all durations are in UTC time and are not impacted by DST (so all days are 24-hours long). This method does not support fractions of seconds, and durations are truncated to seconds. See https://en.wikipedia.org/wiki/ISO_8601#Durations for referece.

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error