docs

Documentation

Index

• type Activity
• type Comments
• type Data
  • func Parse(p *protogen.Plugin) (*Data, error)
• type Descriptor
• type Enum
• type EnumValue
• type Field
• type File
• type Message
• type Package
• type Query
• type RetryPolicy
• type Service
• type Signal
• type Update
• type Workflow
• type WorkflowQuery
• type WorkflowSignal
• type WorkflowUpdate
• type XNS

Types

type Activity

type Activity struct {
	Descriptor
	Comments               Comments
	Deprecated             bool
	HasNonDefaultOptions   bool
	HeartbeatTimeout       time.Duration
	Input                  string
	Name                   string
	Output                 string
	RetryPolicy            *RetryPolicy
	ScheduleToCloseTimeout time.Duration
	ScheduleToStartTimeout time.Duration
	StartToCloseTimeout    time.Duration
	WaitForCancellation    bool
	TaskQueue              string
}

type Comments

type Comments struct {
	Leading       string
	LeadingLines  []string
	Trailing      string
	TrailingLines []string
}

type Data

type Data struct {
	Activities         map[string]Activity
	Enums              map[string]Enum
	Messages           map[string]Message
	ReferencedMessages map[string][]string
	Packages           map[string]Package
	Queries            map[string]Query
	Services           map[string]Service
	Signals            map[string]Signal
	Updates            map[string]Update
	Workflows          map[string]Workflow
}

func Parse

func Parse(p *protogen.Plugin) (*Data, error)

type Descriptor

type Descriptor struct {
	Name     string
	FullName string
	Package  string
	File     File
}

type Enum

type Enum struct {
	Descriptor
	Comments Comments
	Values   []EnumValue
}

type EnumValue

type EnumValue struct {
	Name     string
	Comments Comments
}

type Field

type Field struct {
	Descriptor
	Comments Comments
	GoName   string
	GoTags   string
	JSONName string
	Type     string
}

type File

type File struct {
	Name string
	Path string
}

type Message

type Message struct {
	Descriptor
	Comments Comments
	Enums    []string
	Fields   map[string]Field
	Messages []string
}

type Package

type Package struct {
	Descriptor
	Enums                []string
	HasTemporalResources bool
	Messages             []string
	ReferencedMessages   []string
	Services             []string
}

type Query

type Query struct {
	Descriptor
	Comments             Comments
	Deprecated           bool
	HasNonDefaultOptions bool
	Input                string
	Name                 string
	Output               string
	XNS                  *XNS
}

type RetryPolicy

type RetryPolicy struct {
	BackoffCoefficient     float64
	InitialInterval        time.Duration
	MaxAttempts            int
	MaxInterval            time.Duration
	NonRetryableErrorTypes []string
}

type Service

type Service struct {
	Descriptor
	Activities           []string
	Comments             Comments
	Deprecated           bool
	HasTemporalResources bool
	Queries              []string
	Signals              []string
	TaskQueue            string
	Updates              []string
	Workflows            []string
}

type Signal

type Signal struct {
	Descriptor
	Comments             Comments
	Deprecated           bool
	HasNonDefaultOptions bool
	Input                string
	Name                 string
	XNS                  *XNS
}

type Update

type Update struct {
	Descriptor
	Comments             Comments
	Deprecated           bool
	HasNonDefaultOptions bool
	Input                string
	Name                 string
	Output               string
	Validate             bool
	WaitPolicy           string
	XNS                  *XNS
}

type Workflow

type Workflow struct {
	Descriptor
	Comments            Comments
	Deprecated          bool
	ExecutionTimeout    time.Duration
	ID                  string
	IDReusePolicy       string
	Input               string
	Name                string
	Output              string
	ParentClosePolicy   string
	Queries             map[string]WorkflowQuery
	RetryPolicy         *RetryPolicy
	RunTimeout          time.Duration
	SearchAttributes    string
	Signals             map[string]WorkflowSignal
	TaskQueue           string
	TaskTimeout         time.Duration
	Updates             map[string]WorkflowUpdate
	WaitForCancellation bool
	XNS                 *XNS
}

type WorkflowQuery

type WorkflowQuery struct{}

type WorkflowSignal

type WorkflowSignal struct {
	Start bool
}

type WorkflowUpdate

type WorkflowUpdate struct{}

type XNS

type XNS struct {
	HeartbeatInterval      time.Duration
	HeartbeatTimeout       time.Duration
	Name                   string
	RetryPolicy            *RetryPolicy
	ScheduleToCloseTimeout time.Duration
	ScheduleToStartTimeout time.Duration
	StartToCloseTimeout    time.Duration
	TaskQueue              string
}