common

README

temporalcommonv1

This package contains payload_json.go which is copied to ../../common/v1 after proto generation. The code is kept here separately to keep the delete-entire-directory cleanup before code generation simple.

This code adds "shorthand" formatting support to payloads by implementing MaybeMarshalProtoJSON and MaybeUnmarshalProtoJSON on both Payloads and Payload. Tests for this code are in ../../proxy/marshal_test.go.

Documentation

Index

• Constants
• type Payload
  • func (p *Payload) MaybeMarshalProtoJSON(meta map[string]interface{}, enc *json.Encoder) (handled bool, err error)
  • func (p *Payload) MaybeUnmarshalProtoJSON(meta map[string]interface{}, dec *json.Decoder) (handled bool, err error)
  • func (*Payload) ProtoMessage()
  • func (*Payload) Reset()
  • func (*Payload) String() string
• type Payloads
  • func (p *Payloads) MaybeMarshalProtoJSON(meta map[string]interface{}, enc *json.Encoder) (handled bool, err error)
  • func (p *Payloads) MaybeUnmarshalProtoJSON(meta map[string]interface{}, dec *json.Decoder) (handled bool, err error)

Constants

const EnablePayloadShorthandMetadataKey = "__temporal_enable_payload_shorthand"

Key on the marshaler metadata specifying whether shorthand is enabled.

WARNING: This is internal API and should not be called externally.

Types

type Payload

type Payload struct {
	Metadata map[string][]byte
	Data     []byte
}

func (*Payload) MaybeMarshalProtoJSON

func (p *Payload) MaybeMarshalProtoJSON(meta map[string]interface{}, enc *json.Encoder) (handled bool, err error)

MaybeMarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeMarshaler.MaybeMarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payload) MaybeUnmarshalProtoJSON

func (p *Payload) MaybeUnmarshalProtoJSON(meta map[string]interface{}, dec *json.Decoder) (handled bool, err error)

MaybeUnmarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeUnmarshaler.MaybeUnmarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payload) ProtoMessage

func (*Payload) ProtoMessage()

func (*Payload) Reset

func (*Payload) Reset()

func (*Payload) String

func (*Payload) String() string

type Payloads

type Payloads struct {
	Payloads []*Payload
}

func (*Payloads) MaybeMarshalProtoJSON

func (p *Payloads) MaybeMarshalProtoJSON(meta map[string]interface{}, enc *json.Encoder) (handled bool, err error)

MaybeMarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeMarshaler.MaybeMarshalProtoJSON.

WARNING: This is internal API and should not be called externally.

func (*Payloads) MaybeUnmarshalProtoJSON

func (p *Payloads) MaybeUnmarshalProtoJSON(meta map[string]interface{}, dec *json.Decoder) (handled bool, err error)

MaybeUnmarshalProtoJSON implements go.temporal.io/api/internal/temporaljsonpb.ProtoJSONMaybeUnmarshaler.MaybeUnmarshalProtoJSON.

WARNING: This is internal API and should not be called externally.