types

Documentation

Index

• Variables
• type APIVersionRequestURI
• type ListRequestQuery
• type OutputMode
• type PipelineRequestQuery
• type PipelineRequestURI
• type ProcessRequestURI
• type TriggerRequestURI
• type VariableRequestURI
• type WebhookRequestQuery
• type WebhookRequestUri

Variables

var OutputModeIds = map[OutputMode][]string{
	OutputModeTable: {"table"},
	OutputModeYaml:  {"yaml"},
	OutputModeJson:  {"json"},
}

③ Map enumeration values to their textual representations (value identifiers).

Types

type APIVersionRequestURI

type APIVersionRequestURI struct {
	APIVersion string `uri:"api_version" binding:"required,flowpipe_api_version"`
}

APIVersionRequestURI defines the requested API version.

type ListRequestQuery

type ListRequestQuery struct {
	NextToken string `json:"next_token" form:"next_token" binding:"omitempty"`
	Limit     *int   `json:"limit,omitempty" form:"limit" binding:"omitempty"`
}

type OutputMode

type OutputMode enumflag.Flag

① Define your new enum flag type. It can be derived from enumflag.Flag, but it doesn't need to be as long as it satisfies constraints.Integer.

const (
	OutputModeTable OutputMode = iota
	OutputModeYaml
	OutputModeJson
)

② Define the enumeration values for FooMode.

type PipelineRequestQuery

type PipelineRequestQuery struct {
	ExecutionMode *string `json:"execution_mode" form:"execution_mode" binding:"omitempty,oneof=synchronous asynchronous"`
}

type PipelineRequestURI

type PipelineRequestURI struct {
	PipelineName string `uri:"pipeline_name" binding:"required" format:"^[a-z_]{0,32}$"`
}

type ProcessRequestURI

type ProcessRequestURI struct {
	// TODO: do we want to pass the ExecutionID or PipelineExecutionID? The log is stored under ExecutionID but the execution works with PipelineExecutionID
	// ProcessId string `uri:"process_id" binding:"required" format:"^(pexec|exec)_[0-9a-v]{20}$"`
	ProcessId string `uri:"process_id" binding:"required" format:"^exec_[0-9a-v]{20}$"`
}

type TriggerRequestURI

type TriggerRequestURI struct {
	TriggerName string `uri:"trigger_name" binding:"required" format:"^[a-z]{0,32}$"`
}

type VariableRequestURI

type VariableRequestURI struct {
	VariableName string `uri:"variable_name" binding:"required" format:"^[a-z]{0,32}$"`
}

type WebhookRequestQuery

type WebhookRequestQuery struct {
	ExecutionMode *string `json:"execution_mode" form:"execution_mode" binding:"omitempty,oneof=synchronous asynchronous"`
}

type WebhookRequestUri

type WebhookRequestUri struct {
	Trigger string `json:"trigger" uri:"trigger" binding:"required"`
	Hash    string `json:"hash" uri:"hash" binding:"required"`
}