Documentation
¶
Index ¶
Constants ¶
const ( ValidTypeCreate = "valid-create" ValidTypeUpdate = "valid-update" )
Constants for the validation of the pipeline
const ( ISBServiceStatusHealthy = "healthy" ISBServiceStatusCritical = "critical" ISBServiceStatusWarning = "warning" ISBServiceStatusInactive = "inactive" )
const ( PipelineStatusHealthy = "healthy" PipelineStatusCritical = "critical" PipelineStatusWarning = "warning" PipelineStatusInactive = "inactive" )
Variables ¶
This section is empty.
Functions ¶
func NewHandler ¶
func NewHandler() (*handler, error)
NewHandler is used to provide a new instance of the handler type
Types ¶
type ActiveStatus ¶ added in v0.11.0
type ActiveStatus struct {
Healthy int `json:"Healthy"`
Warning int `json:"Warning"`
Critical int `json:"Critical"`
}
ActiveStatus contains the number of objects in healthy, warning, and critical status.
type ClusterSummary ¶ added in v0.11.0
type ClusterSummary struct {
Namespace string `json:"namespace"`
PipelineSummary PipelineSummary `json:"pipelineSummary"`
IsbServiceSummary IsbServiceSummary `json:"isbServiceSummary"`
}
ClusterSummary summarizes information for a given namespace.
func NewClusterSummary ¶ added in v0.11.0
func NewClusterSummary(namespace string, pipelineSummary PipelineSummary, isbSummary IsbServiceSummary) ClusterSummary
NewClusterSummary creates a new ClusterSummary object with the given specifications.
type ClusterSummaryResponse ¶ added in v0.11.0
type ClusterSummaryResponse []ClusterSummary
ClusterSummaryResponse is a list of ClusterSummary of all the namespaces in a cluster wrapped in a list.
type ISBService ¶ added in v0.11.0
type ISBService struct {
Name string `json:"name"`
Status string `json:"status"`
ISBService v1alpha1.InterStepBufferService `json:"isbService"`
}
ISBService gives the summarized information of an InterStepBufferService
func NewISBService ¶ added in v0.11.0
func NewISBService(status string, isb *v1alpha1.InterStepBufferService) ISBService
NewISBService creates a new ISBService object with the given specifications
type ISBServices ¶ added in v0.11.0
type ISBServices []ISBService
ISBServices is a list of InterStepBufferServices
type IsbServiceSummary ¶ added in v0.11.0
type IsbServiceSummary struct {
Active ActiveStatus `json:"active"`
Inactive int `json:"inactive"`
}
IsbServiceSummary summarizes the number of active and inactive ISB Service.
type K8sEventsResponse ¶ added in v0.11.0
type K8sEventsResponse struct {
TimeStamp int64 `json:"timestamp"`
Type string `json:"type"`
Object string `json:"object"`
Reason string `json:"reason"`
Message string `json:"message"`
}
func NewK8sEventsResponse ¶ added in v0.11.0
func NewK8sEventsResponse(timestamp int64, eventType, objectKind, objectName, reason, message string) K8sEventsResponse
NewK8sEventsResponse creates a new K8sEventsResponse object with the given inputs.
type NumaflowAPIResponse ¶ added in v0.11.0
type NumaflowAPIResponse struct {
// ErrMsg provides more detailed error information. If API call succeeds, the ErrMsg is nil.
ErrMsg *string `json:"errMsg,omitempty"`
// Data is the response body.
Data interface{} `json:"data"`
}
func NewNumaflowAPIResponse ¶ added in v0.11.0
func NewNumaflowAPIResponse(errMsg *string, data interface{}) NumaflowAPIResponse
NewNumaflowAPIResponse creates a new NumaflowAPIResponse.
type PipelineInfo ¶ added in v0.11.0
type PipelineInfo struct {
Name string `json:"name"`
// Status shows whether the pipeline is healthy, warning, critical or inactive.
Status string `json:"status"`
// Lag shows the pipeline lag.
Lag *int64 `json:"lag,omitempty"`
// Pipeline contains the detailed pipeline spec.
Pipeline v1alpha1.Pipeline `json:"pipeline"`
}
func NewPipelineInfo ¶ added in v0.11.0
func NewPipelineInfo(status string, lag *int64, pl *v1alpha1.Pipeline) PipelineInfo
NewPipelineInfo creates a new PipelineInfo object with the given status
type PipelineSummary ¶ added in v0.11.0
type PipelineSummary struct {
Active ActiveStatus `json:"active"`
Inactive int `json:"inactive"`
}
PipelineSummary summarizes the number of active and inactive pipelines.
Source Files