athena_workflow

Documentation

Overview

Package athena_workflow provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.0.0 DO NOT EDIT.

Index

• Constants
• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• func RegisterHandlers(router EchoRouter, si ServerInterface)
• func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
• type EchoRouter
• type ErrorResponse
• type RunAthenaQueryTemplateJSONRequestBody
• type RunAthenaQueryTemplateRequest
• type RunAthenaQueryTemplateResponse
• type RunS3AthenaQueryTemplateJSONRequestBody
• type RunS3AthenaQueryTemplateRequest
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) RunAthenaQueryTemplate(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) RunS3AthenaQueryTemplate(ctx echo.Context) error

Constants

const (
	Sigv4Scopes = "sigv4.Scopes"
)

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

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 PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type EchoRouter

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type ErrorResponse

type ErrorResponse struct {
	// Message Error message
	Message string `json:"message"`
}

ErrorResponse defines model for ErrorResponse.

type RunAthenaQueryTemplateJSONRequestBody

type RunAthenaQueryTemplateJSONRequestBody = RunAthenaQueryTemplateRequest

RunAthenaQueryTemplateJSONRequestBody defines body for RunAthenaQueryTemplate for application/json ContentType.

type RunAthenaQueryTemplateRequest

type RunAthenaQueryTemplateRequest struct {
	// Parameters A list of values for the parameters in an Athena query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
	Parameters *[]string `json:"parameters,omitempty"`

	// TemplateData Data to be passed to the Go template.
	TemplateData *map[string]interface{} `json:"template_data,omitempty"`

	// TemplateQuery Template using Go template syntax, which is used to generate the Athena query.
	TemplateQuery string `json:"template_query"`

	// WaitForCompletion If true the operation will wait for the query to complete before returning the results.
	WaitForCompletion bool `json:"wait_for_completion"`
}

RunAthenaQueryTemplateRequest defines model for RunAthenaQueryTemplateRequest.

type RunAthenaQueryTemplateResponse

type RunAthenaQueryTemplateResponse struct {
	QueryExecutionId    string  `json:"query_execution_id"`
	QueryExecutionState *string `json:"query_execution_state,omitempty"`
	ResultPath          *string `json:"result_path,omitempty"`
}

RunAthenaQueryTemplateResponse defines model for RunAthenaQueryTemplateResponse.

type RunS3AthenaQueryTemplateJSONRequestBody

type RunS3AthenaQueryTemplateJSONRequestBody = RunS3AthenaQueryTemplateRequest

RunS3AthenaQueryTemplateJSONRequestBody defines body for RunS3AthenaQueryTemplate for application/json ContentType.

type RunS3AthenaQueryTemplateRequest

type RunS3AthenaQueryTemplateRequest struct {
	// Parameters A list of values for the parameters in an Athena query. The values are applied sequentially to the parameters in the query in the order in which the parameters occur.
	Parameters *[]string `json:"parameters,omitempty"`

	// TemplateData Data to be passed to the Go template.
	TemplateData *map[string]interface{} `json:"template_data,omitempty"`

	// TemplateName The name of the template file to execute.
	TemplateName string `json:"template_name"`

	// TemplateParsePatterns List of patterns to parse template files from the S3 bucket, this allows you to use includes to split the template into multiple files.
	TemplateParsePatterns []string `json:"template_parse_patterns"`

	// WaitForCompletion If true the operation will wait for the query to complete before returning the results.
	WaitForCompletion bool `json:"wait_for_completion"`
}

RunS3AthenaQueryTemplateRequest defines model for RunS3AthenaQueryTemplateRequest.

type ServerInterface

type ServerInterface interface {

	// (POST /athena/run_query_template)
	RunAthenaQueryTemplate(ctx echo.Context) error

	// (POST /athena/run_s3_query_template)
	RunS3AthenaQueryTemplate(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) RunAthenaQueryTemplate

func (w *ServerInterfaceWrapper) RunAthenaQueryTemplate(ctx echo.Context) error

RunAthenaQueryTemplate converts echo context to params.

func (*ServerInterfaceWrapper) RunS3AthenaQueryTemplate

func (w *ServerInterfaceWrapper) RunS3AthenaQueryTemplate(ctx echo.Context) error

RunS3AthenaQueryTemplate converts echo context to params.