api

Documentation

Index

• func ConstructFullyQualifiedName(resourceType string, length int, resourceName string) string
• func ConstructPipelineFullyQualifiedName(pipelineName string) string
• func ConstructTriggerFullyQualifiedName(triggerName string) string
• func ExecutePipeline(input types.CmdPipeline, executionId, pipelineName string, ...) (types.PipelineExecutionResponse, *event.PipelineQueue, error)
• func ExecuteTrigger(ctx context.Context, input types.CmdTrigger, executionId, triggerName string, ...) (string, error)
• func GetIntegration(name string) (*types.FpIntegration, error)
• func GetNotifier(name string) (*types.FpNotifier, error)
• func GetPipeline(pipelineName string, rootMod string) (*types.FpPipeline, error)
• func GetProcess(executionId string) (*types.Process, error)
• func GetTrigger(triggerName string, rootMod string) (*types.FpTrigger, error)
• func GetVariable(name string) (*types.FpVariable, error)
• func ListIntegrations() (*types.ListIntegrationResponse, error)
• func ListNotifiers() (*types.ListNotifierResponse, error)
• func ListPipelines(rootMod string) (*types.ListPipelineResponse, error)
• func ListProcesses() (*types.ListProcessResponse, error)
• func ListTriggers(rootMod string) (*types.ListTriggerResponse, error)
• func ListVariables() (*types.ListVariableResponse, error)
• func ResumeProcess(executionId string, esService *es.ESService) (pipelineExecutionId, pipelineName string, err error)
• func WaitForTrigger(triggerName, executionId string, waitRetry int) (types.TriggerExecutionResponse, error)
• type APIService
  • func NewAPIService(ctx context.Context, es *es.ESService, opts ...APIServiceOption) (*APIService, error)
  • func (api *APIService) DocsRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) FormRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) IntegrationRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) ModRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) NotifierRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) PipelineRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) ProcessRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) Start() error
  • func (api *APIService) Stop() error
  • func (api *APIService) TriggerRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) VariableRegisterAPI(router *gin.RouterGroup)
  • func (api *APIService) WebhookRegisterAPI(router *gin.RouterGroup)
• type APIServiceOption
  • func WithHTTPAddress(addr string) APIServiceOption
  • func WithHTTPPort(port int) APIServiceOption
• type JSONPayload
• type RootModMetadata

Functions

func ConstructFullyQualifiedName

func ConstructFullyQualifiedName(resourceType string, length int, resourceName string) string

func ConstructPipelineFullyQualifiedName

func ConstructPipelineFullyQualifiedName(pipelineName string) string

func ConstructTriggerFullyQualifiedName

func ConstructTriggerFullyQualifiedName(triggerName string) string

func ExecutePipeline

func ExecutePipeline(input types.CmdPipeline, executionId, pipelineName string, esService *es.ESService) (types.PipelineExecutionResponse, *event.PipelineQueue, error)

func ExecuteTrigger

func ExecuteTrigger(ctx context.Context, input types.CmdTrigger, executionId, triggerName string, esService *es.ESService) (string, error)

func GetIntegration

func GetIntegration(name string) (*types.FpIntegration, error)

func GetNotifier

func GetNotifier(name string) (*types.FpNotifier, error)

func GetPipeline

func GetPipeline(pipelineName string, rootMod string) (*types.FpPipeline, error)

func GetProcess

func GetProcess(executionId string) (*types.Process, error)

func GetTrigger

func GetTrigger(triggerName string, rootMod string) (*types.FpTrigger, error)

func GetVariable

func GetVariable(name string) (*types.FpVariable, error)

func ListIntegrations

func ListIntegrations() (*types.ListIntegrationResponse, error)

func ListNotifiers

func ListNotifiers() (*types.ListNotifierResponse, error)

func ListPipelines

func ListPipelines(rootMod string) (*types.ListPipelineResponse, error)

func ListProcesses

func ListProcesses() (*types.ListProcessResponse, error)

func ListTriggers

func ListTriggers(rootMod string) (*types.ListTriggerResponse, error)

func ListVariables

func ListVariables() (*types.ListVariableResponse, error)

func ResumeProcess

func ResumeProcess(executionId string, esService *es.ESService) (pipelineExecutionId, pipelineName string, err error)

func WaitForTrigger

func WaitForTrigger(triggerName, executionId string, waitRetry int) (types.TriggerExecutionResponse, error)

Types

type APIService

type APIService struct {
	EsService *es.ESService

	HTTPAddress string
	HTTPPort    int

	// Status tracking for the API service.
	Status    string
	StartedAt *time.Time

	StoppedAt *time.Time `json:"stopped_at,omitempty"`

	ModMetadata RootModMetadata
	// contains filtered or unexported fields
}

APIService represents the API service.

func NewAPIService

func NewAPIService(ctx context.Context, es *es.ESService, opts ...APIServiceOption) (*APIService, error)

NewAPIService creates a new APIService.

func (*APIService) DocsRegisterAPI

func (api *APIService) DocsRegisterAPI(router *gin.RouterGroup)

func (*APIService) FormRegisterAPI

func (api *APIService) FormRegisterAPI(router *gin.RouterGroup)

func (*APIService) IntegrationRegisterAPI

func (api *APIService) IntegrationRegisterAPI(router *gin.RouterGroup)

func (*APIService) ModRegisterAPI

func (api *APIService) ModRegisterAPI(router *gin.RouterGroup)

func (*APIService) NotifierRegisterAPI

func (api *APIService) NotifierRegisterAPI(router *gin.RouterGroup)

func (*APIService) PipelineRegisterAPI

func (api *APIService) PipelineRegisterAPI(router *gin.RouterGroup)

func (*APIService) ProcessRegisterAPI

func (api *APIService) ProcessRegisterAPI(router *gin.RouterGroup)

func (*APIService) Start

func (api *APIService) Start() error

Start starts services managed by the Manager.

func (*APIService) Stop

func (api *APIService) Stop() error

Stop stops services managed by the Manager.

func (*APIService) TriggerRegisterAPI

func (api *APIService) TriggerRegisterAPI(router *gin.RouterGroup)

func (*APIService) VariableRegisterAPI

func (api *APIService) VariableRegisterAPI(router *gin.RouterGroup)

func (*APIService) WebhookRegisterAPI

func (api *APIService) WebhookRegisterAPI(router *gin.RouterGroup)

type APIServiceOption

type APIServiceOption func(*APIService) error

APIServiceOption defines a type of function to configures the APIService.

func WithHTTPAddress

func WithHTTPAddress(addr string) APIServiceOption

WithHTTPAddress sets the host and port of the API HTTPS service from the given address string in host:port format.

func WithHTTPPort

func WithHTTPPort(port int) APIServiceOption

WithHTTPPort sets port of the API HTTP service

type JSONPayload

type JSONPayload struct {
	PipelineExecutionID string `json:"pipeline_execution_id"`
	StepExecutionID     string `json:"step_execution_id"`
	ExecutionID         string `json:"execution_id"`
}

type RootModMetadata

type RootModMetadata struct {
	IsStale    bool      `json:"is_stale"`
	LastLoaded time.Time `json:"last_loaded"`
}