entities

Documentation

Overview

Package entities contains representations of Zeebe entities.

Index

• type Job
  • func (j *Job) GetCustomHeadersAs(t interface{}) error
  • func (j *Job) GetCustomHeadersAsMap() (map[string]string, error)
  • func (j *Job) GetVariablesAs(t interface{}) error
  • func (j *Job) GetVariablesAsMap() (map[string]interface{}, error)

Types

type Job

type Job struct {
	pb.ActivatedJob
}

Job represents a single work item of a workflow.

See https://docs.zeebe.io/basics/job-workers.html#what-is-a-job for details on jobs.

func (*Job) GetCustomHeadersAs

func (j *Job) GetCustomHeadersAs(t interface{}) error

GetCustomHeadersAs unmarshals the JSON representation of a workflow's custom headers into type t.

Unlike variables, custom headers are specific to a workflow, as opposed to a workflow instance.

func (*Job) GetCustomHeadersAsMap

func (j *Job) GetCustomHeadersAsMap() (map[string]string, error)

GetCustomHeadersAsMap returns a map of a workflow's custom headers.

Unlike variables, custom headers are specific to a workflow, as opposed to a workflow instance.

func (*Job) GetVariablesAs

func (j *Job) GetVariablesAs(t interface{}) error

GetVariablesAs unmarshals the JSON representation of a workflow instance's variables into type t.

See https://docs.zeebe.io/reference/variables.html for details on workflow variables.

func (*Job) GetVariablesAsMap

func (j *Job) GetVariablesAsMap() (map[string]interface{}, error)

GetVariablesAsMap returns a map of a workflow instance's variables.

See https://docs.zeebe.io/reference/variables.html for details on workflow variables.