model

Documentation

Index

• Variables
• type ApiCallbackRequest
• type ApiJobsResponse
• type ApiRequest
  • func (r *ApiRequest) MarshalJSON() ([]byte, error)
  • func (r *ApiRequest) UnmarshalJSON(data []byte) error
• type ApiResponseError
• type ApiSingleJobResponse
• type Job
  • func NewJob(eventLog *URL, callback *URL, basedir string) (*Job, error)
  • func (j *Job) SetCompletedAt(t time.Time)
  • func (j *Job) SetError(err error)
  • func (j *Job) SetReportCSV(url *URL)
  • func (j *Job) SetResult(result *JobResult)
  • func (j *Job) SetStatus(status JobStatus)
  • func (j *Job) Validate() error
• type JobCteImpact
• type JobResult
• type JobResultReportItem
• type JobResultResourceItem
• type JobStatus
• type URL
  • func (u *URL) MarshalJSON() ([]byte, error)
  • func (u *URL) String() string
  • func (u *URL) UnmarshalJSON(data []byte) error

Variables

var (
	JobStatusPending   = JobStatus("pending")
	JobStatusRunning   = JobStatus("running")
	JobStatusCompleted = JobStatus("completed")
	JobStatusFailed    = JobStatus("failed")
	JobStatusDuplicate = JobStatus("duplicate")
)

Types

type ApiCallbackRequest

type ApiCallbackRequest struct {
	JobID  string `json:"job_id"`
	Status string `json:"status"`
	Error  string `json:"error,omitempty"`
}

ApiCallbackRequest is a body for POST request to the callback endpoint that was specified during job submission.

swagger:model

type ApiJobsResponse

type ApiJobsResponse struct {
	Jobs []*Job `json:"jobs"`
}

ApiJobsResponse is a response for multiple jobs operation.

swagger:model

type ApiRequest

type ApiRequest struct {
	EventLogURL          string `json:"event_log,omitempty"`
	EventLogURL_         *URL   `json:"-"`
	CallbackEndpointURL  string `json:"callback_endpoint,omitempty"`
	CallbackEndpointURL_ *URL   `json:"-"`
}

ApiRequest is a request's body for POST /jobs.

swagger:model

func (*ApiRequest) MarshalJSON

func (r *ApiRequest) MarshalJSON() ([]byte, error)

func (*ApiRequest) UnmarshalJSON

func (r *ApiRequest) UnmarshalJSON(data []byte) error

type ApiResponseError

type ApiResponseError struct {
	Error string `json:"error,omitempty"`
}

ApiResponseError represents an error response from the API.

swagger:model

type ApiSingleJobResponse

type ApiSingleJobResponse struct {
	*Job
}

ApiSingleJobResponse is a response for a single job operation.

swagger:model

type Job

type Job struct {
	ID                      string     `json:"id,omitempty"`
	Status                  JobStatus  `json:"status,omitempty"`
	Error                   string     `json:"error,omitempty"`
	Result                  *JobResult `json:"result,omitempty"`
	ReportCSV               *URL       `json:"report_csv,omitempty"`
	CallbackEndpoint        string     `json:"callback_endpoint,omitempty"`
	CallbackEndpointURL     *URL       `json:"-"`
	EventLog                string     `json:"event_log,omitempty"`
	EventLogURL             *URL       `json:"-"`
	EventLogMD5             string     `json:"event_log_md5,omitempty"`
	EventLogFromRequestBody bool       `json:"-"`
	CreatedAt               time.Time  `json:"created_at,omitempty"`
	CompletedAt             *time.Time `json:"finished_at,omitempty"`

	Dir string `json:"-"`
	// contains filtered or unexported fields
}

Job represents a job to be executed.

swagger:model

func NewJob

func NewJob(eventLog *URL, callback *URL, basedir string) (*Job, error)

func (*Job) SetCompletedAt

func (j *Job) SetCompletedAt(t time.Time)

func (*Job) SetError

func (j *Job) SetError(err error)

func (*Job) SetReportCSV

func (j *Job) SetReportCSV(url *URL)

func (*Job) SetResult

func (j *Job) SetResult(result *JobResult)

func (*Job) SetStatus

func (j *Job) SetStatus(status JobStatus)

func (*Job) Validate

func (j *Job) Validate() error

type JobCteImpact

type JobCteImpact struct {
	BatchingImpact       float64 `json:"batching_impact,omitempty"`
	ContentionImpact     float64 `json:"contention_impact,omitempty"`
	PrioritizationImpact float64 `json:"prioritization_impact,omitempty"`
	UnavailabilityImpact float64 `json:"unavailability_impact,omitempty"`
	ExtraneousImpact     float64 `json:"extraneous_impact,omitempty"`
}

JobCteImpact represents CTE impact of waiting times on the process level.

swagger:model

type JobResult

type JobResult struct {
	NumCases               float64                `json:"num_cases"`
	NumActivities          float64                `json:"num_activities"`
	NumActivityInstances   float64                `json:"num_activity_instances"`
	NumTransitions         float64                `json:"num_transitions"`
	NumTransitionInstances float64                `json:"num_transition_instances"`
	TotalPt                float64                `json:"total_pt"`
	TotalWt                float64                `json:"total_wt"`
	TotalBatchingWt        float64                `json:"total_batching_wt"`
	TotalPrioritizationWt  float64                `json:"total_prioritization_wt"`
	TotalContentionWt      float64                `json:"total_contention_wt"`
	TotalUnavailabilityWt  float64                `json:"total_unavailability_wt"`
	TotalExtraneousWt      float64                `json:"total_extraneous_wt"`
	Report                 []*JobResultReportItem `json:"report"`
	ProcessCTE             float64                `json:"process_cte"`
	CTEImpact              *JobCteImpact          `json:"cte_impact"`
}

JobResult is a result of a job's execution which contains a summary of the transitions analysis report, a report itself and CTE impact of waiting times on the process level and on a transition level.

swagger:model

type JobResultReportItem

type JobResultReportItem struct {
	SourceActivity   string                  `json:"source_activity"`
	TargetActivity   string                  `json:"target_activity"`
	CaseFreq         float64                 `json:"case_freq"`
	TotalFreq        float64                 `json:"total_freq"`
	TotalWt          float64                 `json:"total_wt"`
	BatchingWt       float64                 `json:"batching_wt"`
	PrioritizationWt float64                 `json:"prioritization_wt"`
	ContentionWt     float64                 `json:"contention_wt"`
	UnavailabilityWt float64                 `json:"unavailability_wt"`
	ExtraneousWt     float64                 `json:"extraneous_wt"`
	WtByResource     []JobResultResourceItem `json:"wt_by_resource"`
	CTEImpactTotal   float64                 `json:"cte_impact_total"`
	CTEImpact        *JobCteImpact           `json:"cte_impact"`
}

JobResultReportItem represents a single item of the activity transition in the report.

swagger:model

type JobResultResourceItem

type JobResultResourceItem struct {
	SourceResource   string        `json:"source_resource"`
	TargetResource   string        `json:"target_resource"`
	CaseFreq         float64       `json:"case_freq"`
	TotalFreq        float64       `json:"total_freq"`
	TotalWt          float64       `json:"total_wt"`
	BatchingWt       float64       `json:"batching_wt"`
	PrioritizationWt float64       `json:"prioritization_wt"`
	ContentionWt     float64       `json:"contention_wt"`
	UnavailabilityWt float64       `json:"unavailability_wt"`
	ExtraneousWt     float64       `json:"extraneous_wt"`
	CTEImpact        *JobCteImpact `json:"cte_impact"`
}

JobResultResourceItem represents a resource pair for an activity transition item.

swagger:model

type JobStatus

type JobStatus string

type URL

type URL struct {
	URL *url.URL
}

func (*URL) MarshalJSON

func (u *URL) MarshalJSON() ([]byte, error)

func (*URL) String

func (u *URL) String() string

func (*URL) UnmarshalJSON

func (u *URL) UnmarshalJSON(data []byte) error