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 process.

See https://docs.camunda.io/docs/product-manuals/concepts/job-workers/#job-queueing for details on jobs.

func (*Job) GetCustomHeadersAs

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

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

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

func (*Job) GetCustomHeadersAsMap

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

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

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

func (*Job) GetVariablesAs

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

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

See https://docs.camunda.io/docs/product-manuals/concepts/variables for details on process variables.

func (*Job) GetVariablesAsMap

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

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

See https://docs.camunda.io/docs/product-manuals/concepts/variables for details on process variables.