Documentation
¶
Overview ¶
Package api provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.0 DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (swagger *openapi3.T, err error)
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type ChiServerOptions
- type CreateDAG201JSONResponse
- type CreateDAG400JSONResponse
- type CreateDAGJSONBody
- type CreateDAGJSONRequestBody
- type CreateDAGRequestObject
- type CreateDAGResponseObject
- type CreateDAGdefaultJSONResponse
- type DAG
- type DAGAction
- type DAGDetailTab
- type DAGDetails
- type DAGHistoryData
- type DAGLogGridItem
- type DAGLogStatusFile
- type DAGStatus
- type DAGStatusDetails
- type DAGStatusFile
- type DAGStatusFileDetails
- type DeleteDAG204Response
- type DeleteDAG404JSONResponse
- type DeleteDAGRequestObject
- type DeleteDAGResponseObject
- type DeleteDAGdefaultJSONResponse
- type Error
- type ErrorCode
- type GetDAGDetails200JSONResponse
- type GetDAGDetails404JSONResponse
- type GetDAGDetailsParams
- type GetDAGDetailsRequestObject
- type GetDAGDetailsResponseObject
- type GetDAGDetailsdefaultJSONResponse
- type GetHealth200JSONResponse
- type GetHealth503JSONResponse
- type GetHealthRequestObject
- type GetHealthResponseObject
- type GetHealthdefaultJSONResponse
- type HandlerOn
- type HealthResponse
- type HealthResponseStatus
- type InvalidParamFormatError
- type ListDAGs200JSONResponse
- type ListDAGs400JSONResponse
- type ListDAGsParams
- type ListDAGsRequestObject
- type ListDAGsResponseObject
- type ListDAGsdefaultJSONResponse
- type ListTagResponse
- type ListTags200JSONResponse
- type ListTagsRequestObject
- type ListTagsResponseObject
- type ListTagsdefaultJSONResponse
- type MiddlewareFunc
- type Node
- type NodeStatus
- type NodeStatusText
- type PostDAGAction200JSONResponse
- type PostDAGActionJSONBody
- type PostDAGActionJSONRequestBody
- type PostDAGActionRequestObject
- type PostDAGActionResponse
- type PostDAGActionResponseObject
- type PostDAGActiondefaultJSONResponse
- type Precondition
- type RepeatPolicy
- type RepeatPolicyBackoff0
- type RepeatPolicyBackoff1
- type RepeatPolicy_Backoff
- func (t RepeatPolicy_Backoff) AsRepeatPolicyBackoff0() (RepeatPolicyBackoff0, error)
- func (t RepeatPolicy_Backoff) AsRepeatPolicyBackoff1() (RepeatPolicyBackoff1, error)
- func (t *RepeatPolicy_Backoff) FromRepeatPolicyBackoff0(v RepeatPolicyBackoff0) error
- func (t *RepeatPolicy_Backoff) FromRepeatPolicyBackoff1(v RepeatPolicyBackoff1) error
- func (t RepeatPolicy_Backoff) MarshalJSON() ([]byte, error)
- func (t *RepeatPolicy_Backoff) MergeRepeatPolicyBackoff0(v RepeatPolicyBackoff0) error
- func (t *RepeatPolicy_Backoff) MergeRepeatPolicyBackoff1(v RepeatPolicyBackoff1) error
- func (t *RepeatPolicy_Backoff) UnmarshalJSON(b []byte) error
- type RequiredHeaderError
- type RequiredParamError
- type RunStatus
- type RunStatusText
- type Schedule
- type SchedulerLog
- type SearchDAGs200JSONResponse
- type SearchDAGsMatchItem
- type SearchDAGsParams
- type SearchDAGsRequestObject
- type SearchDAGsResponseObject
- type SearchDAGsResultItem
- type SearchDAGsdefaultJSONResponse
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) CreateDAG(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteDAG(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetDAGDetails(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListDAGs(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListTags(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostDAGAction(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) SearchDAGs(w http.ResponseWriter, r *http.Request)
- type Step
- type StepLog
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type TooManyValuesForParamError
- type UnescapedCookieParamError
- type Unimplemented
- func (_ Unimplemented) CreateDAG(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) DeleteDAG(w http.ResponseWriter, r *http.Request, name string)
- func (_ Unimplemented) GetDAGDetails(w http.ResponseWriter, r *http.Request, name string, ...)
- func (_ Unimplemented) GetHealth(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) ListDAGs(w http.ResponseWriter, r *http.Request, params ListDAGsParams)
- func (_ Unimplemented) ListTags(w http.ResponseWriter, r *http.Request)
- func (_ Unimplemented) PostDAGAction(w http.ResponseWriter, r *http.Request, name string)
- func (_ Unimplemented) SearchDAGs(w http.ResponseWriter, r *http.Request, params SearchDAGsParams)
- type UnmarshalingParamError
Constants ¶
const ( ApiTokenScopes = "apiToken.Scopes" BasicAuthScopes = "basicAuth.Scopes" )
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func Handler ¶
func Handler(si ServerInterface) http.Handler
Handler creates http.Handler with routing matching OpenAPI spec.
func HandlerFromMux ¶
func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
func HandlerWithOptions ¶
func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler
HandlerWithOptions creates http.Handler with additional options
Types ¶
type ChiServerOptions ¶
type ChiServerOptions struct {
BaseURL string
BaseRouter chi.Router
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type CreateDAG201JSONResponse ¶
type CreateDAG201JSONResponse struct {
// DagID Name of the newly created DAG
DagID string `json:"DagID"`
}
func (CreateDAG201JSONResponse) VisitCreateDAGResponse ¶
func (response CreateDAG201JSONResponse) VisitCreateDAGResponse(w http.ResponseWriter) error
type CreateDAG400JSONResponse ¶
type CreateDAG400JSONResponse Error
func (CreateDAG400JSONResponse) VisitCreateDAGResponse ¶
func (response CreateDAG400JSONResponse) VisitCreateDAGResponse(w http.ResponseWriter) error
type CreateDAGJSONBody ¶
type CreateDAGJSONBody struct {
// Action Action to perform upon creation (if any)
Action string `json:"action"`
// Value Associated value for the action
Value string `json:"value"`
}
CreateDAGJSONBody defines parameters for CreateDAG.
type CreateDAGJSONRequestBody ¶
type CreateDAGJSONRequestBody CreateDAGJSONBody
CreateDAGJSONRequestBody defines body for CreateDAG for application/json ContentType.
type CreateDAGRequestObject ¶
type CreateDAGRequestObject struct {
Body *CreateDAGJSONRequestBody
}
type CreateDAGResponseObject ¶
type CreateDAGResponseObject interface {
VisitCreateDAGResponse(w http.ResponseWriter) error
}
type CreateDAGdefaultJSONResponse ¶
func (CreateDAGdefaultJSONResponse) VisitCreateDAGResponse ¶
func (response CreateDAGdefaultJSONResponse) VisitCreateDAGResponse(w http.ResponseWriter) error
type DAG ¶
type DAG struct {
// DefaultParams Default parameter values in JSON format if not specified at runtime
DefaultParams *string `json:"DefaultParams,omitempty"`
// Description Human-readable description of the DAG's purpose and behavior
Description *string `json:"Description,omitempty"`
// Group Logical grouping of related DAGs for organizational purposes
Group *string `json:"Group,omitempty"`
// Name Unique identifier for the DAG within its group
Name string `json:"Name"`
// Params List of parameter names that can be passed to the DAG at runtime
Params *[]string `json:"Params,omitempty"`
// Schedule List of scheduling expressions defining when the DAG should run
Schedule *[]Schedule `json:"Schedule,omitempty"`
// Tags List of tags for categorizing and filtering DAGs
Tags *[]string `json:"Tags,omitempty"`
}
DAG Core DAG configuration containing dag-run definition and metadata
type DAGAction ¶
type DAGAction string
DAGAction Action to be performed on the DAG. Possible values include: - start: Start the DAG - suspend: Suspend the DAG - stop: Stop the DAG - retry: Retry the last run - mark-success: Mark the last run as successful - mark-failed: Mark the last run as failed - save: Save the current state of the DAG - rename: Rename the DAG
const ( DAGActionMarkFailed DAGAction = "mark-failed" DAGActionMarkSuccess DAGAction = "mark-success" DAGActionRename DAGAction = "rename" DAGActionRetry DAGAction = "retry" DAGActionSave DAGAction = "save" DAGActionStart DAGAction = "start" DAGActionStop DAGAction = "stop" DAGActionSuspend DAGAction = "suspend" )
Defines values for DAGAction.
type DAGDetailTab ¶
type DAGDetailTab string
DAGDetailTab Indicates which part of the DAG to retrieve
const ( DAGDetailTabHistory DAGDetailTab = "history" DAGDetailTabLog DAGDetailTab = "log" DAGDetailTabSchedulerLog DAGDetailTab = "scheduler-log" DAGDetailTabSpec DAGDetailTab = "spec" DAGDetailTabStatus DAGDetailTab = "status" )
Defines values for DAGDetailTab.
type DAGDetails ¶
type DAGDetails struct {
// DefaultParams Default parameter values in JSON format if not specified at runtime
DefaultParams *string `json:"DefaultParams,omitempty"`
// Delay Time in seconds to wait before starting the DAG
Delay *int `json:"Delay,omitempty"`
// Description Human-readable description of the DAG's purpose and behavior
Description *string `json:"Description,omitempty"`
// Env List of environment variables to set before executing
Env *[]string `json:"Env,omitempty"`
// Group Logical grouping of related DAGs for organizational purposes
Group *string `json:"Group,omitempty"`
// HandlerOn Configuration for event handlers in a DAG
HandlerOn *HandlerOn `json:"HandlerOn,omitempty"`
// HistRetentionDays Number of days to retain historical logs
HistRetentionDays *int `json:"HistRetentionDays,omitempty"`
// LogDir Directory path for storing log files
LogDir *string `json:"LogDir,omitempty"`
// MaxActiveRuns Maximum number of concurrent steps to run
MaxActiveRuns *int `json:"MaxActiveRuns,omitempty"`
// Name Unique identifier for the DAG within its group
Name string `json:"Name"`
// Params List of parameter names that can be passed to the DAG at runtime
Params *[]string `json:"Params,omitempty"`
// Preconditions Conditions that must be met before the DAG can start
Preconditions *[]Precondition `json:"Preconditions,omitempty"`
// Schedule List of scheduling expressions defining when the DAG should run
Schedule *[]Schedule `json:"Schedule,omitempty"`
// Steps List of steps to execute in the DAG
Steps *[]Step `json:"Steps,omitempty"`
// Tags List of tags for categorizing and filtering DAGs
Tags *[]string `json:"Tags,omitempty"`
}
DAGDetails Detailed DAG configuration information
type DAGHistoryData ¶
type DAGHistoryData struct {
// GridData Grid data for visualization
GridData []DAGLogGridItem `json:"GridData"`
// Logs Detailed status information for each run
Logs []DAGLogStatusFile `json:"Logs"`
}
DAGHistoryData Historical run data for a DAG
type DAGLogGridItem ¶
type DAGLogGridItem struct {
// Name Name of the step
Name string `json:"Name"`
// Vals Status of the step ordered by time
Vals []NodeStatus `json:"Vals"`
}
DAGLogGridItem Grid item for log visualization
type DAGLogStatusFile ¶
type DAGLogStatusFile struct {
// File Path to the log file
File string `json:"File"`
// Status Detailed status of a dag-run including child nodes
Status DAGStatusDetails `json:"Status"`
}
DAGLogStatusFile Log status file information
type DAGStatus ¶
type DAGStatus struct {
// FinishedAt RFC 3339 timestamp when the dag-run finished
FinishedAt string `json:"FinishedAt"`
// Log Path to the log file
Log *string `json:"Log,omitempty"`
// Name Name of the DAG being executed
Name string `json:"Name"`
// Params Runtime parameters passed to the DAG in JSON format
Params *string `json:"Params,omitempty"`
// RequestId Unique identifier for the dag-run request
RequestId string `json:"RequestId"`
// StartedAt RFC 3339 timestamp when the dag-run started
StartedAt string `json:"StartedAt"`
// Status Numeric status code indicating current run state:
// 0: "Not started"
// 1: "Running"
// 2: "Failed"
// 3: "Aborted"
// 4: "Success"
// 6: "Partial Success"
Status RunStatus `json:"Status"`
// StatusText Human-readable status description for the dag-run
StatusText RunStatusText `json:"StatusText"`
}
DAGStatus Current status of a dag-run
type DAGStatusDetails ¶
type DAGStatusDetails struct {
// FinishedAt RFC3339 timestamp when the dag-run finished
FinishedAt string `json:"FinishedAt"`
// Log Path to the log file
Log string `json:"Log"`
// Name Name of the DAG
Name string `json:"Name"`
// Nodes Status of individual steps within the DAG
Nodes []Node `json:"Nodes"`
// OnCancel Status of an individual step within a dag-run
OnCancel *Node `json:"OnCancel,omitempty"`
// OnExit Status of an individual step within a dag-run
OnExit *Node `json:"OnExit,omitempty"`
// OnFailure Status of an individual step within a dag-run
OnFailure *Node `json:"OnFailure,omitempty"`
// OnSuccess Status of an individual step within a dag-run
OnSuccess *Node `json:"OnSuccess,omitempty"`
// Params Parameters in JSON format
Params *string `json:"Params,omitempty"`
// RequestId Unique identifier for the run request
RequestId string `json:"RequestId"`
// StartedAt RFC3339 timestamp when the dag-run started
StartedAt string `json:"StartedAt"`
// Status Numeric status code indicating current run state:
// 0: "Not started"
// 1: "Running"
// 2: "Failed"
// 3: "Aborted"
// 4: "Success"
// 6: "Partial Success"
Status RunStatus `json:"Status"`
// StatusText Human-readable status description for the dag-run
StatusText RunStatusText `json:"StatusText"`
}
DAGStatusDetails Detailed status of a dag-run including child nodes
type DAGStatusFile ¶
type DAGStatusFile struct {
// DAG Core DAG configuration containing dag-run definition and metadata
DAG DAG `json:"DAG"`
// Error Error message if any
Error *string `json:"Error,omitempty"`
// File Path to the DAG file
File string `json:"File"`
// Status Current status of a dag-run
Status DAGStatus `json:"Status"`
// Suspended Whether the DAG is suspended
Suspended bool `json:"Suspended"`
}
DAGStatusFile DAG file with its status information
type DAGStatusFileDetails ¶
type DAGStatusFileDetails struct {
// DAG Detailed DAG configuration information
DAG DAGDetails `json:"DAG"`
// Error Error message if any
Error *string `json:"Error,omitempty"`
// File Path to the DAG file
File string `json:"File"`
// Status Detailed status of a dag-run including child nodes
Status DAGStatusDetails `json:"Status"`
// Suspended Whether the DAG is suspended
Suspended bool `json:"Suspended"`
}
DAGStatusFileDetails Detailed status information for a DAG instance
type DeleteDAG204Response ¶
type DeleteDAG204Response struct {
}
func (DeleteDAG204Response) VisitDeleteDAGResponse ¶
func (response DeleteDAG204Response) VisitDeleteDAGResponse(w http.ResponseWriter) error
type DeleteDAG404JSONResponse ¶
type DeleteDAG404JSONResponse Error
func (DeleteDAG404JSONResponse) VisitDeleteDAGResponse ¶
func (response DeleteDAG404JSONResponse) VisitDeleteDAGResponse(w http.ResponseWriter) error
type DeleteDAGRequestObject ¶
type DeleteDAGRequestObject struct {
Name string `json:"name"`
}
type DeleteDAGResponseObject ¶
type DeleteDAGResponseObject interface {
VisitDeleteDAGResponse(w http.ResponseWriter) error
}
type DeleteDAGdefaultJSONResponse ¶
func (DeleteDAGdefaultJSONResponse) VisitDeleteDAGResponse ¶
func (response DeleteDAGdefaultJSONResponse) VisitDeleteDAGResponse(w http.ResponseWriter) error
type Error ¶
type Error struct {
// Code Error code indicating the type of error
Code ErrorCode `json:"code"`
// Details Additional error details
Details *map[string]interface{} `json:"details,omitempty"`
// Message Short error message
Message string `json:"message"`
}
Error Generic error response object
type ErrorCode ¶
type ErrorCode string
ErrorCode Error code indicating the type of error
const ( ErrorCodeAlreadyExists ErrorCode = "already_exists" ErrorCodeAlreadyRunning ErrorCode = "already_running" ErrorCodeBadGateway ErrorCode = "bad_gateway" ErrorCodeBadRequest ErrorCode = "bad_request" ErrorCodeForbidden ErrorCode = "forbidden" ErrorCodeInternalError ErrorCode = "internal_error" ErrorCodeNotFound ErrorCode = "not_found" ErrorCodeNotRunning ErrorCode = "not_running" ErrorCodeRemoteNodeError ErrorCode = "remote_node_error" )
Defines values for ErrorCode.
type GetDAGDetails200JSONResponse ¶
type GetDAGDetails200JSONResponse struct {
// DAG Detailed status information for a DAG instance
DAG DAGStatusFileDetails `json:"DAG"`
// Definition DAG definition
Definition *string `json:"Definition,omitempty"`
// Errors List of errors encountered during the request
Errors []string `json:"Errors"`
// LogData Historical run data for a DAG
LogData *DAGHistoryData `json:"LogData,omitempty"`
// LogUrl URL to access logs directly
LogUrl *string `json:"LogUrl,omitempty"`
// ScLog Log information for the scheduler
ScLog *SchedulerLog `json:"ScLog,omitempty"`
// StepLog Log information for a specific step
StepLog *StepLog `json:"StepLog,omitempty"`
// Title Title of the Page
Title string `json:"Title"`
}
func (GetDAGDetails200JSONResponse) VisitGetDAGDetailsResponse ¶
func (response GetDAGDetails200JSONResponse) VisitGetDAGDetailsResponse(w http.ResponseWriter) error
type GetDAGDetails404JSONResponse ¶
type GetDAGDetails404JSONResponse Error
func (GetDAGDetails404JSONResponse) VisitGetDAGDetailsResponse ¶
func (response GetDAGDetails404JSONResponse) VisitGetDAGDetailsResponse(w http.ResponseWriter) error
type GetDAGDetailsParams ¶
type GetDAGDetailsParams struct {
// Tab Specific part of the DAG to retrieve
Tab *DAGDetailTab `form:"tab,omitempty" json:"tab,omitempty"`
File *string `form:"file,omitempty" json:"file,omitempty"`
// Step Step name within the DAG
Step *string `form:"step,omitempty" json:"step,omitempty"`
}
GetDAGDetailsParams defines parameters for GetDAGDetails.
type GetDAGDetailsRequestObject ¶
type GetDAGDetailsRequestObject struct {
Name string `json:"name"`
Params GetDAGDetailsParams
}
type GetDAGDetailsResponseObject ¶
type GetDAGDetailsResponseObject interface {
VisitGetDAGDetailsResponse(w http.ResponseWriter) error
}
type GetDAGDetailsdefaultJSONResponse ¶
func (GetDAGDetailsdefaultJSONResponse) VisitGetDAGDetailsResponse ¶
func (response GetDAGDetailsdefaultJSONResponse) VisitGetDAGDetailsResponse(w http.ResponseWriter) error
type GetHealth200JSONResponse ¶
type GetHealth200JSONResponse HealthResponse
func (GetHealth200JSONResponse) VisitGetHealthResponse ¶
func (response GetHealth200JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type GetHealth503JSONResponse ¶
type GetHealth503JSONResponse HealthResponse
func (GetHealth503JSONResponse) VisitGetHealthResponse ¶
func (response GetHealth503JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type GetHealthRequestObject ¶
type GetHealthRequestObject struct {
}
type GetHealthResponseObject ¶
type GetHealthResponseObject interface {
VisitGetHealthResponse(w http.ResponseWriter) error
}
type GetHealthdefaultJSONResponse ¶
func (GetHealthdefaultJSONResponse) VisitGetHealthResponse ¶
func (response GetHealthdefaultJSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type HandlerOn ¶
type HandlerOn struct {
// Cancel Individual task within a DAG that performs a specific operation
Cancel *Step `json:"Cancel,omitempty"`
// Exit Individual task within a DAG that performs a specific operation
Exit *Step `json:"Exit,omitempty"`
// Failure Individual task within a DAG that performs a specific operation
Failure *Step `json:"Failure,omitempty"`
// Success Individual task within a DAG that performs a specific operation
Success *Step `json:"Success,omitempty"`
}
HandlerOn Configuration for event handlers in a DAG
type HealthResponse ¶
type HealthResponse struct {
// Status Overall health status of the server
Status HealthResponseStatus `json:"status"`
// Timestamp Current server time
Timestamp string `json:"timestamp"`
// Uptime Server uptime in seconds
Uptime int `json:"uptime"`
// Version Current version of the server
Version string `json:"version"`
}
HealthResponse Response object for the health check endpoint
type HealthResponseStatus ¶
type HealthResponseStatus string
HealthResponseStatus Overall health status of the server
const ( HealthResponseStatusHealthy HealthResponseStatus = "healthy" HealthResponseStatusUnhealthy HealthResponseStatus = "unhealthy" )
Defines values for HealthResponseStatus.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListDAGs200JSONResponse ¶
type ListDAGs200JSONResponse struct {
// DAGs List of DAGs with their status and metadata
DAGs []DAGStatusFile `json:"DAGs"`
// Errors List of errors encountered during the request
Errors *[]string `json:"Errors,omitempty"`
// HasError Whether any errors were encountered
HasError bool `json:"HasError"`
// PageCount Total number of pages available
PageCount int `json:"PageCount"`
}
func (ListDAGs200JSONResponse) VisitListDAGsResponse ¶
func (response ListDAGs200JSONResponse) VisitListDAGsResponse(w http.ResponseWriter) error
type ListDAGs400JSONResponse ¶
type ListDAGs400JSONResponse Error
func (ListDAGs400JSONResponse) VisitListDAGsResponse ¶
func (response ListDAGs400JSONResponse) VisitListDAGsResponse(w http.ResponseWriter) error
type ListDAGsParams ¶
type ListDAGsParams struct {
// Page Page number (for pagination)
Page *int `form:"page,omitempty" json:"page,omitempty"`
// Limit Number of items to return per page
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
// SearchName Filter DAGs by name
SearchName *string `form:"searchName,omitempty" json:"searchName,omitempty"`
// SearchTag Filter DAGs by tag
SearchTag *string `form:"searchTag,omitempty" json:"searchTag,omitempty"`
}
ListDAGsParams defines parameters for ListDAGs.
type ListDAGsRequestObject ¶
type ListDAGsRequestObject struct {
Params ListDAGsParams
}
type ListDAGsResponseObject ¶
type ListDAGsResponseObject interface {
VisitListDAGsResponse(w http.ResponseWriter) error
}
type ListDAGsdefaultJSONResponse ¶
func (ListDAGsdefaultJSONResponse) VisitListDAGsResponse ¶
func (response ListDAGsdefaultJSONResponse) VisitListDAGsResponse(w http.ResponseWriter) error
type ListTagResponse ¶
type ListTagResponse struct {
// Errors List of errors encountered during the request
Errors []string `json:"Errors"`
// Tags List of unique tags
Tags []string `json:"Tags"`
}
ListTagResponse Response object for listing all tags
type ListTags200JSONResponse ¶
type ListTags200JSONResponse ListTagResponse
func (ListTags200JSONResponse) VisitListTagsResponse ¶
func (response ListTags200JSONResponse) VisitListTagsResponse(w http.ResponseWriter) error
type ListTagsRequestObject ¶
type ListTagsRequestObject struct {
}
type ListTagsResponseObject ¶
type ListTagsResponseObject interface {
VisitListTagsResponse(w http.ResponseWriter) error
}
type ListTagsdefaultJSONResponse ¶
func (ListTagsdefaultJSONResponse) VisitListTagsResponse ¶
func (response ListTagsdefaultJSONResponse) VisitListTagsResponse(w http.ResponseWriter) error
type Node ¶
type Node struct {
// DoneCount Number of successful completions for repeating steps
DoneCount int `json:"DoneCount"`
// Error Error message if the step failed
Error *string `json:"Error,omitempty"`
// FinishedAt RFC3339 timestamp when the step finished
FinishedAt string `json:"FinishedAt"`
// Log Path to step-specific log file
Log string `json:"Log"`
// RetryCount Number of retry attempts made for this step
RetryCount int `json:"RetryCount"`
// StartedAt RFC3339 timestamp when the step started
StartedAt string `json:"StartedAt"`
// Status Numeric status code indicating current node state:
// 0: "Not started"
// 1: "Running"
// 2: "Failed"
// 3: "Aborted"
// 4: "Success"
// 5: "Skipped"
// 6: "Partial Success"
Status NodeStatus `json:"Status"`
// StatusText Human-readable status description for the node
StatusText NodeStatusText `json:"StatusText"`
// Step Individual task within a DAG that performs a specific operation
Step Step `json:"Step"`
}
Node Status of an individual step within a dag-run
type NodeStatus ¶
type NodeStatus int
NodeStatus Numeric status code indicating current node state: 0: "Not started" 1: "Running" 2: "Failed" 3: "Aborted" 4: "Success" 5: "Skipped" 6: "Partial Success"
const ( NodeStatusN0 NodeStatus = 0 NodeStatusN1 NodeStatus = 1 NodeStatusN2 NodeStatus = 2 NodeStatusN3 NodeStatus = 3 NodeStatusN4 NodeStatus = 4 NodeStatusN5 NodeStatus = 5 NodeStatusN6 NodeStatus = 6 )
Defines values for NodeStatus.
type NodeStatusText ¶
type NodeStatusText string
NodeStatusText Human-readable status description for the node
const ( NodeStatusTextAborted NodeStatusText = "aborted" NodeStatusTextFailed NodeStatusText = "failed" NodeStatusTextFinished NodeStatusText = "finished" NodeStatusTextNotStarted NodeStatusText = "not started" NodeStatusTextPartialSuccess NodeStatusText = "partial success" NodeStatusTextRunning NodeStatusText = "running" NodeStatusTextSkipped NodeStatusText = "skipped" )
Defines values for NodeStatusText.
type PostDAGAction200JSONResponse ¶
type PostDAGAction200JSONResponse PostDAGActionResponse
func (PostDAGAction200JSONResponse) VisitPostDAGActionResponse ¶
func (response PostDAGAction200JSONResponse) VisitPostDAGActionResponse(w http.ResponseWriter) error
type PostDAGActionJSONBody ¶
type PostDAGActionJSONBody struct {
// Action Action to be performed on the DAG. Possible values include:
// - start: Start the DAG
// - suspend: Suspend the DAG
// - stop: Stop the DAG
// - retry: Retry the last run
// - mark-success: Mark the last run as successful
// - mark-failed: Mark the last run as failed
// - save: Save the current state of the DAG
// - rename: Rename the DAG
Action DAGAction `json:"action"`
// Params Additional parameters for the action in JSON format
Params *string `json:"params,omitempty"`
// RequestId Unique request ID for the action
RequestId *string `json:"requestId,omitempty"`
// Step Step name if the action targets a specific step
Step *string `json:"step,omitempty"`
// Value Optional extra value for the action
Value *string `json:"value,omitempty"`
}
PostDAGActionJSONBody defines parameters for PostDAGAction.
type PostDAGActionJSONRequestBody ¶
type PostDAGActionJSONRequestBody PostDAGActionJSONBody
PostDAGActionJSONRequestBody defines body for PostDAGAction for application/json ContentType.
type PostDAGActionRequestObject ¶
type PostDAGActionRequestObject struct {
Name string `json:"name"`
Body *PostDAGActionJSONRequestBody
}
type PostDAGActionResponse ¶
type PostDAGActionResponse struct {
// NewName New DAG name, if the action resulted in a new DAG
NewName *string `json:"NewName,omitempty"`
}
PostDAGActionResponse Response object for posting an action to a DAG
type PostDAGActionResponseObject ¶
type PostDAGActionResponseObject interface {
VisitPostDAGActionResponse(w http.ResponseWriter) error
}
type PostDAGActiondefaultJSONResponse ¶
func (PostDAGActiondefaultJSONResponse) VisitPostDAGActionResponse ¶
func (response PostDAGActiondefaultJSONResponse) VisitPostDAGActionResponse(w http.ResponseWriter) error
type Precondition ¶
type Precondition struct {
// Condition Expression or check to evaluate
Condition *string `json:"Condition,omitempty"`
// Expected Expected result of the condition evaluation
Expected *string `json:"Expected,omitempty"`
}
Precondition Precondition that must be satisfied before running a step or DAG
type RepeatPolicy ¶
type RepeatPolicy struct {
Backoff *RepeatPolicy_Backoff `json:"Backoff,omitempty"`
// Interval Time in seconds to wait between retry attempts
Interval *int `json:"Interval,omitempty"`
// MaxIntervalSec Maximum interval in seconds (caps exponential growth)
MaxIntervalSec *int `json:"MaxIntervalSec,omitempty"`
// Repeat Whether the step should be retried on failure
Repeat *bool `json:"Repeat,omitempty"`
}
RepeatPolicy Configuration for step retry behavior
type RepeatPolicyBackoff0 ¶ added in v1.18.0
type RepeatPolicyBackoff0 = bool
RepeatPolicyBackoff0 When true, uses default multiplier of 2.0
type RepeatPolicyBackoff1 ¶ added in v1.18.0
type RepeatPolicyBackoff1 = float32
RepeatPolicyBackoff1 Custom exponential backoff multiplier
type RepeatPolicy_Backoff ¶ added in v1.18.0
type RepeatPolicy_Backoff struct {
// contains filtered or unexported fields
}
RepeatPolicy_Backoff defines model for RepeatPolicy.Backoff.
func (RepeatPolicy_Backoff) AsRepeatPolicyBackoff0 ¶ added in v1.18.0
func (t RepeatPolicy_Backoff) AsRepeatPolicyBackoff0() (RepeatPolicyBackoff0, error)
AsRepeatPolicyBackoff0 returns the union data inside the RepeatPolicy_Backoff as a RepeatPolicyBackoff0
func (RepeatPolicy_Backoff) AsRepeatPolicyBackoff1 ¶ added in v1.18.0
func (t RepeatPolicy_Backoff) AsRepeatPolicyBackoff1() (RepeatPolicyBackoff1, error)
AsRepeatPolicyBackoff1 returns the union data inside the RepeatPolicy_Backoff as a RepeatPolicyBackoff1
func (*RepeatPolicy_Backoff) FromRepeatPolicyBackoff0 ¶ added in v1.18.0
func (t *RepeatPolicy_Backoff) FromRepeatPolicyBackoff0(v RepeatPolicyBackoff0) error
FromRepeatPolicyBackoff0 overwrites any union data inside the RepeatPolicy_Backoff as the provided RepeatPolicyBackoff0
func (*RepeatPolicy_Backoff) FromRepeatPolicyBackoff1 ¶ added in v1.18.0
func (t *RepeatPolicy_Backoff) FromRepeatPolicyBackoff1(v RepeatPolicyBackoff1) error
FromRepeatPolicyBackoff1 overwrites any union data inside the RepeatPolicy_Backoff as the provided RepeatPolicyBackoff1
func (RepeatPolicy_Backoff) MarshalJSON ¶ added in v1.18.0
func (t RepeatPolicy_Backoff) MarshalJSON() ([]byte, error)
func (*RepeatPolicy_Backoff) MergeRepeatPolicyBackoff0 ¶ added in v1.18.0
func (t *RepeatPolicy_Backoff) MergeRepeatPolicyBackoff0(v RepeatPolicyBackoff0) error
MergeRepeatPolicyBackoff0 performs a merge with any union data inside the RepeatPolicy_Backoff, using the provided RepeatPolicyBackoff0
func (*RepeatPolicy_Backoff) MergeRepeatPolicyBackoff1 ¶ added in v1.18.0
func (t *RepeatPolicy_Backoff) MergeRepeatPolicyBackoff1(v RepeatPolicyBackoff1) error
MergeRepeatPolicyBackoff1 performs a merge with any union data inside the RepeatPolicy_Backoff, using the provided RepeatPolicyBackoff1
func (*RepeatPolicy_Backoff) UnmarshalJSON ¶ added in v1.18.0
func (t *RepeatPolicy_Backoff) UnmarshalJSON(b []byte) error
type RequiredHeaderError ¶
func (*RequiredHeaderError) Error ¶
func (e *RequiredHeaderError) Error() string
func (*RequiredHeaderError) Unwrap ¶
func (e *RequiredHeaderError) Unwrap() error
type RequiredParamError ¶
type RequiredParamError struct {
ParamName string
}
func (*RequiredParamError) Error ¶
func (e *RequiredParamError) Error() string
type RunStatus ¶
type RunStatus int
RunStatus Numeric status code indicating current run state: 0: "Not started" 1: "Running" 2: "Failed" 3: "Aborted" 4: "Success" 6: "Partial Success"
type RunStatusText ¶
type RunStatusText string
RunStatusText Human-readable status description for the dag-run
const ( RunStatusTextAborted RunStatusText = "aborted" RunStatusTextFailed RunStatusText = "failed" RunStatusTextFinished RunStatusText = "finished" RunStatusTextNotStarted RunStatusText = "not started" RunStatusTextPartialSuccess RunStatusText = "partial success" RunStatusTextRunning RunStatusText = "running" )
Defines values for RunStatusText.
type Schedule ¶
type Schedule struct {
// Expression Cron expression or schedule pattern
Expression string `json:"Expression"`
}
Schedule Schedule configuration for dag-run
type SchedulerLog ¶
type SchedulerLog struct {
// Content Log content
Content string `json:"Content"`
// LogFile Path to the scheduler log file
LogFile string `json:"LogFile"`
}
SchedulerLog Log information for the scheduler
type SearchDAGs200JSONResponse ¶
type SearchDAGs200JSONResponse struct {
// Errors Errors encountered during the search
Errors []string `json:"Errors"`
// Results Search results matching the query
Results []SearchDAGsResultItem `json:"Results"`
}
func (SearchDAGs200JSONResponse) VisitSearchDAGsResponse ¶
func (response SearchDAGs200JSONResponse) VisitSearchDAGsResponse(w http.ResponseWriter) error
type SearchDAGsMatchItem ¶
type SearchDAGsMatchItem struct {
// Line Matching line content
Line string `json:"Line"`
// LineNumber Line number where match was found
LineNumber int `json:"LineNumber"`
// StartLine Start line for context
StartLine int `json:"StartLine"`
}
SearchDAGsMatchItem Details of a search match within a DAG
type SearchDAGsParams ¶
type SearchDAGsParams struct {
// Q A search query string
Q string `form:"q" json:"q"`
}
SearchDAGsParams defines parameters for SearchDAGs.
type SearchDAGsRequestObject ¶
type SearchDAGsRequestObject struct {
Params SearchDAGsParams
}
type SearchDAGsResponseObject ¶
type SearchDAGsResponseObject interface {
VisitSearchDAGsResponse(w http.ResponseWriter) error
}
type SearchDAGsResultItem ¶
type SearchDAGsResultItem struct {
// DAG Core DAG configuration containing dag-run definition and metadata
DAG DAG `json:"DAG"`
// Matches Details of where matches were found
Matches []SearchDAGsMatchItem `json:"Matches"`
// Name Name of the matching DAG
Name string `json:"Name"`
}
SearchDAGsResultItem Individual search result item for a DAG
type SearchDAGsdefaultJSONResponse ¶
func (SearchDAGsdefaultJSONResponse) VisitSearchDAGsResponse ¶
func (response SearchDAGsdefaultJSONResponse) VisitSearchDAGsResponse(w http.ResponseWriter) error
type ServerInterface ¶
type ServerInterface interface {
// List all DAGs
// (GET /dags)
ListDAGs(w http.ResponseWriter, r *http.Request, params ListDAGsParams)
// Create a new DAG
// (POST /dags)
CreateDAG(w http.ResponseWriter, r *http.Request)
// Delete a DAG
// (DELETE /dags/{name})
DeleteDAG(w http.ResponseWriter, r *http.Request, name string)
// Get DAG details
// (GET /dags/{name})
GetDAGDetails(w http.ResponseWriter, r *http.Request, name string, params GetDAGDetailsParams)
// Perform an action on a DAG
// (POST /dags/{name})
PostDAGAction(w http.ResponseWriter, r *http.Request, name string)
// Health check endpoint
// (GET /health)
GetHealth(w http.ResponseWriter, r *http.Request)
// Search DAGs
// (GET /search)
SearchDAGs(w http.ResponseWriter, r *http.Request, params SearchDAGsParams)
// List all tags
// (GET /tags)
ListTags(w http.ResponseWriter, r *http.Request)
}
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
func NewStrictHandlerWithOptions ¶
func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
HandlerMiddlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) CreateDAG ¶
func (siw *ServerInterfaceWrapper) CreateDAG(w http.ResponseWriter, r *http.Request)
CreateDAG operation middleware
func (*ServerInterfaceWrapper) DeleteDAG ¶
func (siw *ServerInterfaceWrapper) DeleteDAG(w http.ResponseWriter, r *http.Request)
DeleteDAG operation middleware
func (*ServerInterfaceWrapper) GetDAGDetails ¶
func (siw *ServerInterfaceWrapper) GetDAGDetails(w http.ResponseWriter, r *http.Request)
GetDAGDetails operation middleware
func (*ServerInterfaceWrapper) GetHealth ¶
func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)
GetHealth operation middleware
func (*ServerInterfaceWrapper) ListDAGs ¶
func (siw *ServerInterfaceWrapper) ListDAGs(w http.ResponseWriter, r *http.Request)
ListDAGs operation middleware
func (*ServerInterfaceWrapper) ListTags ¶
func (siw *ServerInterfaceWrapper) ListTags(w http.ResponseWriter, r *http.Request)
ListTags operation middleware
func (*ServerInterfaceWrapper) PostDAGAction ¶
func (siw *ServerInterfaceWrapper) PostDAGAction(w http.ResponseWriter, r *http.Request)
PostDAGAction operation middleware
func (*ServerInterfaceWrapper) SearchDAGs ¶
func (siw *ServerInterfaceWrapper) SearchDAGs(w http.ResponseWriter, r *http.Request)
SearchDAGs operation middleware
type Step ¶
type Step struct {
// Args List of arguments to pass to the command
Args *[]string `json:"Args,omitempty"`
// CmdWithArgs Complete command string including arguments to execute
CmdWithArgs *string `json:"CmdWithArgs,omitempty"`
// Command Base command to execute without arguments
Command *string `json:"Command,omitempty"`
// Depends List of step names that must complete before this step can start
Depends *[]string `json:"Depends,omitempty"`
// Description Human-readable description of what the step does
Description *string `json:"Description,omitempty"`
// Dir Working directory for executing the step's command
Dir *string `json:"Dir,omitempty"`
// MailOnError Whether to send email notifications on step failure
MailOnError *bool `json:"MailOnError,omitempty"`
// Name Unique identifier for the step within the DAG
Name string `json:"Name"`
// Output Variable name to store the step's output
Output *string `json:"Output,omitempty"`
// Params Parameters to pass to the sub DAG in JSON format
Params *string `json:"Params,omitempty"`
// Preconditions Conditions that must be met before the step can start
Preconditions *[]Precondition `json:"Preconditions,omitempty"`
// RepeatPolicy Configuration for step retry behavior
RepeatPolicy *RepeatPolicy `json:"RepeatPolicy,omitempty"`
// Run Sub DAG to run
Run *string `json:"Run,omitempty"`
// Script Script content if the step executes a script file
Script *string `json:"Script,omitempty"`
// Stderr File path for capturing standard error
Stderr *string `json:"Stderr,omitempty"`
// Stdout File path for capturing standard output
Stdout *string `json:"Stdout,omitempty"`
}
Step Individual task within a DAG that performs a specific operation
type StepLog ¶
type StepLog struct {
// Content Log content
Content string `json:"Content"`
// LogFile Path to the log file
LogFile string `json:"LogFile"`
// Step Status of an individual step within a dag-run
Step Node `json:"Step"`
}
StepLog Log information for a specific step
type StrictHTTPServerOptions ¶
type StrictHTTPServerOptions struct {
RequestErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
type StrictHandlerFunc ¶
type StrictHandlerFunc = strictnethttp.StrictHTTPHandlerFunc
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc = strictnethttp.StrictHTTPMiddlewareFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// List all DAGs
// (GET /dags)
ListDAGs(ctx context.Context, request ListDAGsRequestObject) (ListDAGsResponseObject, error)
// Create a new DAG
// (POST /dags)
CreateDAG(ctx context.Context, request CreateDAGRequestObject) (CreateDAGResponseObject, error)
// Delete a DAG
// (DELETE /dags/{name})
DeleteDAG(ctx context.Context, request DeleteDAGRequestObject) (DeleteDAGResponseObject, error)
// Get DAG details
// (GET /dags/{name})
GetDAGDetails(ctx context.Context, request GetDAGDetailsRequestObject) (GetDAGDetailsResponseObject, error)
// Perform an action on a DAG
// (POST /dags/{name})
PostDAGAction(ctx context.Context, request PostDAGActionRequestObject) (PostDAGActionResponseObject, error)
// Health check endpoint
// (GET /health)
GetHealth(ctx context.Context, request GetHealthRequestObject) (GetHealthResponseObject, error)
// Search DAGs
// (GET /search)
SearchDAGs(ctx context.Context, request SearchDAGsRequestObject) (SearchDAGsResponseObject, error)
// List all tags
// (GET /tags)
ListTags(ctx context.Context, request ListTagsRequestObject) (ListTagsResponseObject, error)
}
StrictServerInterface represents all server handlers.
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type Unimplemented ¶
type Unimplemented struct{}
func (Unimplemented) CreateDAG ¶
func (_ Unimplemented) CreateDAG(w http.ResponseWriter, r *http.Request)
Create a new DAG (POST /dags)
func (Unimplemented) DeleteDAG ¶
func (_ Unimplemented) DeleteDAG(w http.ResponseWriter, r *http.Request, name string)
Delete a DAG (DELETE /dags/{name})
func (Unimplemented) GetDAGDetails ¶
func (_ Unimplemented) GetDAGDetails(w http.ResponseWriter, r *http.Request, name string, params GetDAGDetailsParams)
Get DAG details (GET /dags/{name})
func (Unimplemented) GetHealth ¶
func (_ Unimplemented) GetHealth(w http.ResponseWriter, r *http.Request)
Health check endpoint (GET /health)
func (Unimplemented) ListDAGs ¶
func (_ Unimplemented) ListDAGs(w http.ResponseWriter, r *http.Request, params ListDAGsParams)
List all DAGs (GET /dags)
func (Unimplemented) ListTags ¶
func (_ Unimplemented) ListTags(w http.ResponseWriter, r *http.Request)
List all tags (GET /tags)
func (Unimplemented) PostDAGAction ¶
func (_ Unimplemented) PostDAGAction(w http.ResponseWriter, r *http.Request, name string)
Perform an action on a DAG (POST /dags/{name})
func (Unimplemented) SearchDAGs ¶
func (_ Unimplemented) SearchDAGs(w http.ResponseWriter, r *http.Request, params SearchDAGsParams)
Search DAGs (GET /search)
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error