job

Documentation

Index

• Variables
• func AddSubtaskEvent(ctx context.Context, cfg *types.BaseTargetConfig, ...)
• func AddTaskEvent(ctx context.Context, cfg *types.BaseTargetConfig, jobID, jobType string, ...)
• func StartJob(ctx context.Context, cfg *types.BaseTargetConfig) (string, error)
• func UpdateJobEvent(cfg *types.BaseTargetConfig, jobID string, status JobStatus, inputErr error)
• type Job
• type JobStatus
  • func (e JobStatus) IsRunning() bool
  • func (e JobStatus) IsValid() bool
  • func (e JobStatus) MarshalJSON() ([]byte, error)
  • func (e JobStatus) String() string
  • func (e *JobStatus) UnmarshalJSON(b []byte) error
• type Response
• type Subtask
  • func GetSubtask(ctx context.Context, cfg *types.BaseTargetConfig, ...) (*Subtask, error)
  • func WaitForJobToComplete(ctx context.Context, jobID string, syncType string, subtaskId string, ...) (*Subtask, error)
• type SubtaskEventUpdater
• type SubtaskResponse
• type Task
• type TaskEventUpdater
  • func NewTaskEventUpdater(cfg *types.BaseTargetConfig, jobId, jobType string, ...) TaskEventUpdater
• type TaskPart
• type TaskResult

Variables

var AllJobStatus = []JobStatus{
	Started,
	InProgress,
	DataRetrieve,
	DataUpload,
	Queued,
	DataProcessing,
	Completed,
	Failed,
	Skipped,
	TimeOut,
}

Functions

func AddSubtaskEvent

func AddSubtaskEvent(ctx context.Context, cfg *types.BaseTargetConfig, jobID, jobType, subtask string, status JobStatus, receivedDate *int64)

func AddTaskEvent

func AddTaskEvent(ctx context.Context, cfg *types.BaseTargetConfig, jobID, jobType string, status JobStatus, taskResults []TaskResult, warnings []string, errors []error)

func StartJob

func StartJob(ctx context.Context, cfg *types.BaseTargetConfig) (string, error)

func UpdateJobEvent

func UpdateJobEvent(cfg *types.BaseTargetConfig, jobID string, status JobStatus, inputErr error)

Types

type Job

type Job struct {
	JobID *string `json:"jobId"`
}

type JobStatus

type JobStatus int

const (
	Started JobStatus = iota
	InProgress
	DataRetrieve
	DataUpload
	Queued
	DataProcessing
	Completed
	Failed
	Skipped
	TimeOut
)

func (JobStatus) IsRunning

func (e JobStatus) IsRunning() bool

func (JobStatus) IsValid

func (e JobStatus) IsValid() bool

func (JobStatus) MarshalJSON

func (e JobStatus) MarshalJSON() ([]byte, error)

func (JobStatus) String

func (e JobStatus) String() string

func (*JobStatus) UnmarshalJSON

func (e *JobStatus) UnmarshalJSON(b []byte) error

type Response

type Response struct {
	Job Job `json:"createJob"`
}

type Subtask

type Subtask struct {
	JobID      string      `json:"jobId"`
	JobType    string      `json:"jobType"`
	SubtaskId  string      `json:"subtaskId"`
	Status     JobStatus   `json:"status"`
	LastUpdate time.Time   `json:"lastUpdate"`
	Result     interface{} `json:"result"`
	Errors     []string    `json:"errors"`
}

func GetSubtask

func GetSubtask(ctx context.Context, cfg *types.BaseTargetConfig, jobID, jobType, subtaskId string, responseResult interface{}) (*Subtask, error)

func WaitForJobToComplete

func WaitForJobToComplete(ctx context.Context, jobID string, syncType string, subtaskId string, syncResult interface{}, cfg *types.BaseTargetConfig, currentStatus JobStatus) (*Subtask, error)

type SubtaskEventUpdater

type SubtaskEventUpdater interface {
	AddSubtaskEvent(ctx context.Context, status JobStatus)
	SetReceivedDate(receivedDate int64)
}

type SubtaskResponse

type SubtaskResponse struct {
	SubtaskResponse Subtask `json:"jobSubtask"`
}

type Task

type Task interface {
	IsClientValid(ctx context.Context, c plugin.PluginClient) (bool, error)
	GetParts() []TaskPart
	GetTaskResults() []TaskResult
}

type TaskEventUpdater

type TaskEventUpdater interface {
	SetStatusToStarted(ctx context.Context)
	SetStatusToDataRetrieve(ctx context.Context)
	SetStatusToDataUpload(ctx context.Context)
	SetStatusToQueued(ctx context.Context)
	SetStatusToDataProcessing(ctx context.Context)
	SetStatusToCompleted(ctx context.Context, results []TaskResult)
	SetStatusToFailed(ctx context.Context, err error)
	SetStatusToSkipped(ctx context.Context)

	GetSubtaskEventUpdater(subtask string) SubtaskEventUpdater
}

func NewTaskEventUpdater

func NewTaskEventUpdater(cfg *types.BaseTargetConfig, jobId, jobType string, warningCollector logging.WarningCollector) TaskEventUpdater

type TaskPart

type TaskPart interface {
	StartSyncAndQueueTaskPart(ctx context.Context, c plugin.PluginClient, statusUpdater TaskEventUpdater) (JobStatus, string, error)
	ProcessResults(results interface{}) error
	GetResultObject() interface{}
}

type TaskResult

type TaskResult struct {
	ObjectType string `json:"objectType"`
	Added      int    `json:"added"`
	Updated    int    `json:"updated"`
	Removed    int    `json:"removed"`
	Failed     int    `json:"failed"`
}