Documentation
¶
Index ¶
- Constants
- type CollectWorkflowMapNode
- type ConfigDataNode
- type DynamicElement
- type Error
- type Metric
- type MetricInfo
- type Plugin
- type PolicyTable
- type PolicyTableSlice
- type ProcessWorkflowMapNode
- type PublishWorkflowMapNode
- type RuleTable
- type Schedule
- type StreamedMetric
- type StreamedMetrics
- type StreamedTaskEvent
- type Task
- type Tasks
- type UnauthError
- type WorkflowMap
Constants ¶
const ( // ScheduleTypeSimple captures enum value "simple" ScheduleTypeSimple string = "simple" // ScheduleTypeNrWindowed captures enum value " windowed" ScheduleTypeNrWindowed string = " windowed" // ScheduleTypeNrStreaming captures enum value " streaming" ScheduleTypeNrStreaming string = " streaming" // ScheduleTypeNrCron captures enum value " cron" ScheduleTypeNrCron string = " cron" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CollectWorkflowMapNode ¶
type CollectWorkflowMapNode struct {
// config
Config map[string]map[string]interface{} `json:"config,omitempty"`
// metrics
// Required: true
Metrics map[string]MetricInfo `json:"metrics"`
// process
Process []*ProcessWorkflowMapNode `json:"process"`
// publish
Publish []*PublishWorkflowMapNode `json:"publish"`
// tags
Tags map[string]map[string]string `json:"tags,omitempty"`
}
CollectWorkflowMapNode CollectWorkflowMapNode represents Snap workflow data model. swagger:model CollectWorkflowMapNode
func (*CollectWorkflowMapNode) MarshalBinary ¶
func (m *CollectWorkflowMapNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CollectWorkflowMapNode) UnmarshalBinary ¶
func (m *CollectWorkflowMapNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConfigDataNode ¶
type ConfigDataNode interface{}
ConfigDataNode Represents a set of configuration data swagger:model ConfigDataNode
type DynamicElement ¶
type DynamicElement struct {
// description
Description string `json:"description,omitempty"`
// index
Index int64 `json:"index,omitempty"`
// name
// Required: true
Name *string `json:"name"`
}
DynamicElement dynamic element swagger:model DynamicElement
func (*DynamicElement) MarshalBinary ¶
func (m *DynamicElement) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DynamicElement) UnmarshalBinary ¶
func (m *DynamicElement) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// error message
ErrorMessage string `json:"message,omitempty"`
// fields
Fields map[string]string `json:"fields,omitempty"`
}
Error Unsuccessful generic response to a failed API call swagger:model Error
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Metric ¶
type Metric struct {
// description
Description string `json:"description,omitempty"`
// Dynamic boolean representation if the metric has dynamic element.
Dynamic bool `json:"dynamic,omitempty"`
// DynamicElements a slice of dynamic elements.
DynamicElements []*DynamicElement `json:"dynamic_elements"`
// href
Href string `json:"href,omitempty"`
// last advertised timestamp
LastAdvertisedTimestamp int64 `json:"last_advertised_timestamp,omitempty"`
// namespace
// Required: true
Namespace *string `json:"namespace"`
// unit
Unit string `json:"unit,omitempty"`
// version
Version int64 `json:"version,omitempty"`
// policy
Policy PolicyTableSlice `json:"policy"`
}
Metric Metric represents the metric type. swagger:model Metric
func (*Metric) MarshalBinary ¶
MarshalBinary interface implementation
func (*Metric) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MetricInfo ¶
type MetricInfo struct {
// version
Version int64 `json:"version,omitempty"`
}
MetricInfo metric info swagger:model metricInfo
func (*MetricInfo) MarshalBinary ¶
func (m *MetricInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricInfo) UnmarshalBinary ¶
func (m *MetricInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Plugin ¶
type Plugin struct {
// config policy
ConfigPolicy []PolicyTable `json:"config_policy"`
// hit count
HitCount int64 `json:"hitcount,omitempty"`
// href
Href string `json:"href,omitempty"`
// ID
ID uint32 `json:"id,omitempty"`
// last hit timestamp
LastHitTimestamp int64 `json:"last_hit_timestamp,omitempty"`
// loaded timestamp
LoadedTimestamp int64 `json:"loaded_timestamp,omitempty"`
// name
Name string `json:"name,omitempty"`
// pprof port
PprofPort string `json:"pprof_port,omitempty"`
// signed
Signed bool `json:"signed,omitempty"`
// status
Status string `json:"status,omitempty"`
// type
Type string `json:"type,omitempty"`
// version
Version int64 `json:"version,omitempty"`
}
Plugin Plugin represents a plugin type definition. swagger:model Plugin
func (*Plugin) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugin) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PolicyTable ¶
type PolicyTable struct {
RuleTable
}
PolicyTable policy table swagger:model PolicyTable
func (*PolicyTable) MarshalBinary ¶
func (m *PolicyTable) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PolicyTable) MarshalJSON ¶
func (m PolicyTable) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PolicyTable) UnmarshalBinary ¶
func (m *PolicyTable) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PolicyTable) UnmarshalJSON ¶
func (m *PolicyTable) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type PolicyTableSlice ¶
type PolicyTableSlice []*RuleTable
PolicyTableSlice policy table slice swagger:model PolicyTableSlice
type ProcessWorkflowMapNode ¶
type ProcessWorkflowMapNode struct {
// Config the configuration of a processor.
Config map[string]interface{} `json:"config,omitempty"`
// plugin name
// Required: true
PluginName *string `json:"plugin_name"`
// plugin version
PluginVersion int64 `json:"plugin_version,omitempty"`
// process
Process []*ProcessWorkflowMapNode `json:"process"`
// publish
Publish []*PublishWorkflowMapNode `json:"publish"`
// target
Target string `json:"target,omitempty"`
}
ProcessWorkflowMapNode process workflow map node swagger:model ProcessWorkflowMapNode
func (*ProcessWorkflowMapNode) MarshalBinary ¶
func (m *ProcessWorkflowMapNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProcessWorkflowMapNode) UnmarshalBinary ¶
func (m *ProcessWorkflowMapNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PublishWorkflowMapNode ¶
type PublishWorkflowMapNode struct {
// config
// Required: true
Config map[string]interface{} `json:"config"`
// plugin name
// Required: true
PluginName *string `json:"plugin_name"`
// plugin version
PluginVersion int64 `json:"plugin_version,omitempty"`
// target
Target string `json:"target,omitempty"`
}
PublishWorkflowMapNode publish workflow map node swagger:model PublishWorkflowMapNode
func (*PublishWorkflowMapNode) MarshalBinary ¶
func (m *PublishWorkflowMapNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PublishWorkflowMapNode) UnmarshalBinary ¶
func (m *PublishWorkflowMapNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RuleTable ¶
type RuleTable struct {
// default
Default interface{} `json:"default,omitempty"`
// maximum
Maximum interface{} `json:"maximum,omitempty"`
// minimum
Minimum interface{} `json:"minimum,omitempty"`
// name
Name string `json:"name,omitempty"`
// required
Required bool `json:"required,omitempty"`
// type
Type string `json:"type,omitempty"`
}
RuleTable rule table swagger:model RuleTable
func (*RuleTable) MarshalBinary ¶
MarshalBinary interface implementation
func (*RuleTable) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Schedule ¶
type Schedule struct {
// count
Count uint64 `json:"count,omitempty"`
// interval
// Required: true
Interval *string `json:"interval"`
// start timestamp
StartTimestamp interface{} `json:"start_timestamp,omitempty"`
// stop timestamp
StopTimestamp interface{} `json:"stop_timestamp,omitempty"`
// type
// Required: true
Type *string `json:"type"`
}
Schedule Schedule defines a scheduler. swagger:model Schedule
func (*Schedule) MarshalBinary ¶
MarshalBinary interface implementation
func (*Schedule) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type StreamedMetric ¶
type StreamedMetric struct {
// data
Data interface{} `json:"data,omitempty"`
// namespace
Namespace string `json:"namespace,omitempty"`
// tags
Tags map[string]string `json:"tags,omitempty"`
// timestamp
Timestamp interface{} `json:"timestamp,omitempty"`
}
StreamedMetric streamed metric swagger:model StreamedMetric
func (*StreamedMetric) MarshalBinary ¶
func (m *StreamedMetric) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StreamedMetric) UnmarshalBinary ¶
func (m *StreamedMetric) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StreamedMetrics ¶
type StreamedMetrics []*StreamedMetric
StreamedMetrics StreamedMetrics defines a slice of streamed metrics. swagger:model StreamedMetrics
type StreamedTaskEvent ¶
type StreamedTaskEvent struct {
// event type
EventType string `json:"type,omitempty"`
// message
Message string `json:"message,omitempty"`
// event
Event StreamedMetrics `json:"event"`
}
StreamedTaskEvent StreamedTaskEvent defines the task watching data type. swagger:model StreamedTaskEvent
func (*StreamedTaskEvent) MarshalBinary ¶
func (m *StreamedTaskEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StreamedTaskEvent) UnmarshalBinary ¶
func (m *StreamedTaskEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Task ¶
type Task struct {
// creation timestamp
CreationTimestamp int64 `json:"creation_timestamp,omitempty"`
// deadline
Deadline string `json:"deadline,omitempty"`
// failed count
FailedCount int64 `json:"failed_count,omitempty"`
// hit count
HitCount int64 `json:"hit_count,omitempty"`
// href
Href string `json:"href,omitempty"`
// ID
ID string `json:"id,omitempty"`
// last failure message
LastFailureMessage string `json:"last_failure_message,omitempty"`
// last run timestamp
LastRunTimestamp int64 `json:"last_run_timestamp,omitempty"`
// max failures
MaxFailures int64 `json:"max-failures,omitempty"`
// miss count
MissCount int64 `json:"miss_count,omitempty"`
// name
Name string `json:"name,omitempty"`
// start
Start bool `json:"start,omitempty"`
// task state
TaskState string `json:"task_state,omitempty"`
// version
Version int64 `json:"version,omitempty"`
// schedule
Schedule *Schedule `json:"schedule,omitempty"`
// workflow
Workflow *WorkflowMap `json:"workflow,omitempty"`
}
Task Task represents Snap task definition. swagger:model Task
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UnauthError ¶
type UnauthError struct {
// code
Code int64 `json:"code,omitempty"`
// message
Message string `json:"message,omitempty"`
}
UnauthError UnauthError defines the error type of an unauthorized response. swagger:model UnauthError
func (*UnauthError) MarshalBinary ¶
func (m *UnauthError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UnauthError) UnmarshalBinary ¶
func (m *UnauthError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WorkflowMap ¶
type WorkflowMap struct {
// collect
// Required: true
Collect *CollectWorkflowMapNode `json:"collect"`
}
WorkflowMap WorkflowMap represents a map of a desired workflow that is used to create a scheduleWorkflow swagger:model WorkflowMap
func (*WorkflowMap) MarshalBinary ¶
func (m *WorkflowMap) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WorkflowMap) UnmarshalBinary ¶
func (m *WorkflowMap) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- collect_workflow_map_node.go
- config_data_node.go
- dynamic_element.go
- error.go
- metric.go
- metric_info.go
- plugin.go
- policy_table.go
- policy_table_slice.go
- process_workflow_map_node.go
- publish_workflow_map_node.go
- rule_table.go
- schedule.go
- streamed_metric.go
- streamed_metrics.go
- streamed_task_event.go
- task.go
- tasks.go
- unauth_error.go
- workflow_map.go