server

package
v0.41.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 12, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DecodeSubmitRequest 

func DecodeSubmitRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeSubmitRequest returns a decoder for requests sent to the batch submit endpoint.

func EncodeHintsResponse added in v0.35.0 

func EncodeHintsResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeHintsResponse returns an encoder for responses returned by the batch hints endpoint.

func EncodeStatusResponse 

func EncodeStatusResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeStatusResponse returns an encoder for responses returned by the batch status endpoint.

func EncodeSubmitError 

func EncodeSubmitError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeSubmitError returns an encoder for errors returned by the submit batch endpoint.

func EncodeSubmitResponse 

func EncodeSubmitResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeSubmitResponse returns an encoder for responses returned by the batch submit endpoint.

func HandleBatchOrigin added in v0.31.0 

func HandleBatchOrigin(h http.Handler) http.Handler

HandleBatchOrigin applies the CORS response headers corresponding to the origin for the service batch.

func HintsBatchPath added in v0.35.0 

func HintsBatchPath() string

HintsBatchPath returns the URL path to the batch service hints HTTP endpoint.

func Mount 

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the batch endpoints.

func MountCORSHandler 

func MountCORSHandler(mux goahttp.Muxer, h http.Handler)

MountCORSHandler configures the mux to serve the CORS endpoints for the service batch.

func MountHintsHandler added in v0.35.0 

func MountHintsHandler(mux goahttp.Muxer, h http.Handler)

MountHintsHandler configures the mux to serve the "batch" service "hints" endpoint.

func MountStatusHandler 

func MountStatusHandler(mux goahttp.Muxer, h http.Handler)

MountStatusHandler configures the mux to serve the "batch" service "status" endpoint.

func MountSubmitHandler 

func MountSubmitHandler(mux goahttp.Muxer, h http.Handler)

MountSubmitHandler configures the mux to serve the "batch" service "submit" endpoint.

func NewCORSHandler 

func NewCORSHandler() http.Handler

NewCORSHandler creates a HTTP handler which returns a simple 200 response.

func NewHintsHandler added in v0.35.0 

func NewHintsHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewHintsHandler creates a HTTP handler which loads the HTTP request and calls the "batch" service "hints" endpoint.

func NewStatusHandler 

func NewStatusHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewStatusHandler creates a HTTP handler which loads the HTTP request and calls the "batch" service "status" endpoint.

func NewSubmitHandler 

func NewSubmitHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewSubmitHandler creates a HTTP handler which loads the HTTP request and calls the "batch" service "submit" endpoint.

func NewSubmitPayload 

func NewSubmitPayload(body *SubmitRequestBody) *batch.SubmitPayload

NewSubmitPayload builds a batch service submit endpoint payload.

func StatusBatchPath 

func StatusBatchPath() string

StatusBatchPath returns the URL path to the batch service status HTTP endpoint.

func SubmitBatchPath 

func SubmitBatchPath() string

SubmitBatchPath returns the URL path to the batch service submit HTTP endpoint.

func ValidateSubmitRequestBody 

func ValidateSubmitRequestBody(body *SubmitRequestBody) (err error)

ValidateSubmitRequestBody runs the validations defined on SubmitRequestBody

Types

type HintsResponseBody added in v0.35.0 

type HintsResponseBody struct {
	// A list of known values of completedDir used by existing watchers.
	CompletedDirs []string `form:"completed_dirs,omitempty" json:"completed_dirs,omitempty" xml:"completed_dirs,omitempty"`
}

HintsResponseBody is the type of the "batch" service "hints" endpoint HTTP response body.

func NewHintsResponseBody added in v0.35.0 

func NewHintsResponseBody(res *batch.BatchHintsResult) *HintsResponseBody

NewHintsResponseBody builds the HTTP response body from the result of the "hints" endpoint of the "batch" service.

type MountPoint 

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type Server 

type Server struct {
	Mounts []*MountPoint
	Submit http.Handler
	Status http.Handler
	Hints  http.Handler
	CORS   http.Handler
}

Server lists the batch service endpoint HTTP handlers.

func New 

func New(
	e *batch.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the batch service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) MethodNames added in v0.37.0 

func (s *Server) MethodNames() []string

MethodNames returns the methods served.

func (*Server) Mount added in v0.34.0 

func (s *Server) Mount(mux goahttp.Muxer)

Mount configures the mux to serve the batch endpoints.

func (*Server) Service 

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use 

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.

type StatusResponseBody 

type StatusResponseBody struct {
	Running    bool    `form:"running" json:"running" xml:"running"`
	Status     *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	WorkflowID *string `form:"workflow_id,omitempty" json:"workflow_id,omitempty" xml:"workflow_id,omitempty"`
	RunID      *string `form:"run_id,omitempty" json:"run_id,omitempty" xml:"run_id,omitempty"`
}

StatusResponseBody is the type of the "batch" service "status" endpoint HTTP response body.

func NewStatusResponseBody 

func NewStatusResponseBody(res *batch.BatchStatusResult) *StatusResponseBody

NewStatusResponseBody builds the HTTP response body from the result of the "status" endpoint of the "batch" service.

type SubmitNotAvailableResponseBody 

type SubmitNotAvailableResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

SubmitNotAvailableResponseBody is the type of the "batch" service "submit" endpoint HTTP response body for the "not_available" error.

func NewSubmitNotAvailableResponseBody 

func NewSubmitNotAvailableResponseBody(res *goa.ServiceError) *SubmitNotAvailableResponseBody

NewSubmitNotAvailableResponseBody builds the HTTP response body from the result of the "submit" endpoint of the "batch" service.

type SubmitNotValidResponseBody 

type SubmitNotValidResponseBody struct {
	// Name is the name of this class of errors.
	Name string `form:"name" json:"name" xml:"name"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID string `form:"id" json:"id" xml:"id"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message string `form:"message" json:"message" xml:"message"`
	// Is the error temporary?
	Temporary bool `form:"temporary" json:"temporary" xml:"temporary"`
	// Is the error a timeout?
	Timeout bool `form:"timeout" json:"timeout" xml:"timeout"`
	// Is the error a server-side fault?
	Fault bool `form:"fault" json:"fault" xml:"fault"`
}

SubmitNotValidResponseBody is the type of the "batch" service "submit" endpoint HTTP response body for the "not_valid" error.

func NewSubmitNotValidResponseBody 

func NewSubmitNotValidResponseBody(res *goa.ServiceError) *SubmitNotValidResponseBody

NewSubmitNotValidResponseBody builds the HTTP response body from the result of the "submit" endpoint of the "batch" service.

type SubmitRequestBody 

type SubmitRequestBody struct {
	Path                *string `form:"path,omitempty" json:"path,omitempty" xml:"path,omitempty"`
	Pipeline            *string `form:"pipeline,omitempty" json:"pipeline,omitempty" xml:"pipeline,omitempty"`
	ProcessingConfig    *string `form:"processing_config,omitempty" json:"processing_config,omitempty" xml:"processing_config,omitempty"`
	CompletedDir        *string `form:"completed_dir,omitempty" json:"completed_dir,omitempty" xml:"completed_dir,omitempty"`
	RetentionPeriod     *string `form:"retention_period,omitempty" json:"retention_period,omitempty" xml:"retention_period,omitempty"`
	RejectDuplicates    *bool   `form:"reject_duplicates,omitempty" json:"reject_duplicates,omitempty" xml:"reject_duplicates,omitempty"`
	ExcludeHiddenFiles  *bool   `form:"exclude_hidden_files,omitempty" json:"exclude_hidden_files,omitempty" xml:"exclude_hidden_files,omitempty"`
	TransferType        *string `form:"transfer_type,omitempty" json:"transfer_type,omitempty" xml:"transfer_type,omitempty"`
	ProcessNameMetadata *bool   `form:"process_name_metadata,omitempty" json:"process_name_metadata,omitempty" xml:"process_name_metadata,omitempty"`
	Depth               *int    `form:"depth,omitempty" json:"depth,omitempty" xml:"depth,omitempty"`
}

SubmitRequestBody is the type of the "batch" service "submit" endpoint HTTP request body.

type SubmitResponseBody 

type SubmitResponseBody struct {
	WorkflowID string `form:"workflow_id" json:"workflow_id" xml:"workflow_id"`
	RunID      string `form:"run_id" json:"run_id" xml:"run_id"`
}

SubmitResponseBody is the type of the "batch" service "submit" endpoint HTTP response body.

func NewSubmitResponseBody 

func NewSubmitResponseBody(res *batch.BatchResult) *SubmitResponseBody

NewSubmitResponseBody builds the HTTP response body from the result of the "submit" endpoint of the "batch" service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.