Documentation
¶
Index ¶
- Variables
- type Adapter
- type Application
- type Bucket
- type BucketContent
- type Client
- type Conflict
- type File
- type Filter
- type Identity
- type NotFound
- type Param
- type Params
- type Path
- type Proxy
- type ResetError
- type RuleSet
- type Setting
- type SoftError
- type Tag
- type TagCategory
- type Task
- func (h *Task) Activity(entry string, v ...interface{})
- func (h *Task) Application() (r *api.Application, err error)
- func (h *Task) Attach(f *api.File)
- func (h *Task) AttachAt(f *api.File, activity int)
- func (h *Task) Bucket() (b *binding.BucketContent)
- func (h *Task) Completed(n int)
- func (h *Task) Data() (d map[string]interface{})
- func (h *Task) DataWith(object interface{}) (err error)
- func (h *Task) Error(error ...api.TaskError)
- func (h *Task) Errorf(severity, description string, v ...interface{})
- func (h *Task) Failed(reason string, v ...interface{})
- func (h *Task) Increment()
- func (h *Task) Load()
- func (h *Task) Result(object interface{})
- func (h *Task) Started()
- func (h *Task) Succeeded()
- func (h *Task) Total(n int)
- func (h *Task) Variant() string
Constants ¶
This section is empty.
Variables ¶
View Source
var ( Settings = &settings.Settings Log = logr.WithName("addon") )
Functions ¶
This section is empty.
Types ¶
type Adapter ¶
type Adapter struct {
// Task API.
Task
// Log API.
Log logapi.Logger
// Settings API.
Setting Setting
// Application API.
Application Application
// Identity API.
Identity Identity
// Proxy API.
Proxy Proxy
// TagCategory API.
TagCategory TagCategory
// Tag API.
Tag Tag
// File API.
File File
// RuleSet API
RuleSet RuleSet
// contains filtered or unexported fields
}
The Adapter provides hub/addon integration.
var Addon *Adapter
Addon An addon adapter configured for a task execution.
type BucketContent ¶ added in v0.3.0
type BucketContent = binding.BucketContent
type SoftError ¶
type SoftError struct {
Reason string
}
SoftError A "soft" anticipated error. Deprecated:
type TagCategory ¶ added in v0.1.0
type TagCategory = binding.TagCategory
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Task API.
func (*Task) Activity ¶
Activity report addon activity. The description can be a printf style format.
func (*Task) Application ¶
func (h *Task) Application() (r *api.Application, err error)
Application returns the application associated with the task.
func (*Task) Attach ¶ added in v0.3.0
Attach ensures the file is attached to the report associated with the last entry in the activity.
func (*Task) AttachAt ¶ added in v0.3.0
AttachAt ensures the file is attached to the report indexed to the activity. The activity is a 1-based index. Zero(0) means NOT associated.
func (*Task) Bucket ¶
func (h *Task) Bucket() (b *binding.BucketContent)
Bucket returns the bucket API.
Source Files
Click to show internal directories.
Click to hide internal directories.