job

Documentation

Index

• type AttributeKey
• type EnqueuedStatus
• type Id
• type Job
  • func (j *Job) Initialise() *Job
  • func (j *Job) IsProcessed() bool
  • func (j *Job) RecordCompletionTime()
  • func (j *Job) RecordTimeForAttribute(key AttributeKey)
  • func (j *Job) SetStatus(status Status)
  • func (j *Job) Status() Status
• type Queue
  • func (jq *Queue) Enqueue(newJob *Job) EnqueuedStatus
  • func (jq *Queue) Initialise() *Queue
  • func (jq *Queue) Start()
  • func (jq *Queue) WithQueueLength(length uint64) *Queue
• type Status

Types

type AttributeKey

type AttributeKey string

type EnqueuedStatus

type EnqueuedStatus bool

const EnqueueFailed EnqueuedStatus = false

const EnqueueSucceeded EnqueuedStatus = true

type Id

type Id string

type Job

type Job struct {
	Id               Id
	Attributes       map[AttributeKey]interface{}
	HiddenAttributes map[AttributeKey]interface{} `json:"-"`
}

func (*Job) Initialise

func (j *Job) Initialise() *Job

func (*Job) IsProcessed

func (j *Job) IsProcessed() bool

func (*Job) RecordCompletionTime

func (j *Job) RecordCompletionTime()

func (*Job) RecordTimeForAttribute

func (j *Job) RecordTimeForAttribute(key AttributeKey)

func (*Job) SetStatus

func (j *Job) SetStatus(status Status)

func (*Job) Status

func (j *Job) Status() Status

type Queue

type Queue struct {
	Jobs        chan *Job      `json:"-"`
	JobFunction func(job *Job) `json:"-"`
}

func (*Queue) Enqueue

func (jq *Queue) Enqueue(newJob *Job) EnqueuedStatus

func (*Queue) Initialise

func (jq *Queue) Initialise() *Queue

func (*Queue) Start

func (jq *Queue) Start()

func (*Queue) WithQueueLength

func (jq *Queue) WithQueueLength(length uint64) *Queue

type Status

type Status AttributeKey

const (
	Unspecified Status = "UNSPECIFIED"
	Created     Status = "CREATED"
	Completed   Status = "COMPLETED"
	Errored     Status = "ERRORED"
	Invalid     Status = "INVALID"
)