operations

package
v0.0.0-...-02f41c6 Latest Latest
Warning

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

 Go to latest Published: Sep 7, 2021 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const ChunkHistoryBadRequestCode int = 400

ChunkHistoryBadRequestCode is the HTTP code returned for type ChunkHistoryBadRequest

View Source 
const ChunkHistoryOKCode int = 200

ChunkHistoryOKCode is the HTTP code returned for type ChunkHistoryOK

View Source 
const GetTimezoneBadRequestCode int = 400

GetTimezoneBadRequestCode is the HTTP code returned for type GetTimezoneBadRequest

View Source 
const GetTimezoneOKCode int = 200

GetTimezoneOKCode is the HTTP code returned for type GetTimezoneOK

Variables

This section is empty.

Functions

This section is empty.

Types

type ChunkHistory 

type ChunkHistory struct {
	Context *middleware.Context
	Handler ChunkHistoryHandler
}
ChunkHistory swagger:route POST /history/chunk chunkHistory

ChunkHistory chunk history API

func NewChunkHistory 

func NewChunkHistory(ctx *middleware.Context, handler ChunkHistoryHandler) *ChunkHistory

NewChunkHistory creates a new http.Handler for the chunk history operation

func (*ChunkHistory) ServeHTTP 

func (o *ChunkHistory) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type ChunkHistoryBadRequest 

type ChunkHistoryBadRequest struct {
}

ChunkHistoryBadRequest Bad request.

swagger:response chunkHistoryBadRequest

func NewChunkHistoryBadRequest 

func NewChunkHistoryBadRequest() *ChunkHistoryBadRequest

NewChunkHistoryBadRequest creates ChunkHistoryBadRequest with default headers values

func (*ChunkHistoryBadRequest) WriteResponse 

func (o *ChunkHistoryBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ChunkHistoryHandler 

type ChunkHistoryHandler interface {
	Handle(ChunkHistoryParams) middleware.Responder
}

ChunkHistoryHandler interface for that can handle valid chunk history params

type ChunkHistoryHandlerFunc 

type ChunkHistoryHandlerFunc func(ChunkHistoryParams) middleware.Responder

ChunkHistoryHandlerFunc turns a function with the right signature into a chunk history handler

func (ChunkHistoryHandlerFunc) Handle 

func (fn ChunkHistoryHandlerFunc) Handle(params ChunkHistoryParams) middleware.Responder

Handle executing the request and returning a response

type ChunkHistoryOK 

type ChunkHistoryOK struct {

	/*
	  In: Body
	*/
	Payload *models.HistoryBlocks `json:"body,omitempty"`
}

ChunkHistoryOK History blocks filtered.

swagger:response chunkHistoryOK

func NewChunkHistoryOK 

func NewChunkHistoryOK() *ChunkHistoryOK

NewChunkHistoryOK creates ChunkHistoryOK with default headers values

func (*ChunkHistoryOK) SetPayload 

func (o *ChunkHistoryOK) SetPayload(payload *models.HistoryBlocks)

SetPayload sets the payload to the chunk history o k response

func (*ChunkHistoryOK) WithPayload 

func (o *ChunkHistoryOK) WithPayload(payload *models.HistoryBlocks) *ChunkHistoryOK

WithPayload adds the payload to the chunk history o k response

func (*ChunkHistoryOK) WriteResponse 

func (o *ChunkHistoryOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type ChunkHistoryParams 

type ChunkHistoryParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  Required: true
	  In: body
	*/
	Body *models.ChunkHistoryParams
}

ChunkHistoryParams contains all the bound params for the chunk history operation typically these are obtained from a http.Request

swagger:parameters chunkHistory

func NewChunkHistoryParams 

func NewChunkHistoryParams() ChunkHistoryParams

NewChunkHistoryParams creates a new ChunkHistoryParams object

There are no default values defined in the spec.

func (*ChunkHistoryParams) BindRequest 

func (o *ChunkHistoryParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewChunkHistoryParams() beforehand.

type ChunkHistoryURL 

type ChunkHistoryURL struct {
	// contains filtered or unexported fields
}

ChunkHistoryURL generates an URL for the chunk history operation

func (*ChunkHistoryURL) Build 

func (o *ChunkHistoryURL) Build() (*url.URL, error)

Build a url path and query string

func (*ChunkHistoryURL) BuildFull 

func (o *ChunkHistoryURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*ChunkHistoryURL) Must 

func (o *ChunkHistoryURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*ChunkHistoryURL) SetBasePath 

func (o *ChunkHistoryURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*ChunkHistoryURL) String 

func (o *ChunkHistoryURL) String() string

String returns the string representation of the path with query string

func (*ChunkHistoryURL) StringFull 

func (o *ChunkHistoryURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*ChunkHistoryURL) WithBasePath 

func (o *ChunkHistoryURL) WithBasePath(bp string) *ChunkHistoryURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type FishHistoryAPI 

type FishHistoryAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator

	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator

	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// ChunkHistoryHandler sets the operation handler for the chunk history operation
	ChunkHistoryHandler ChunkHistoryHandler
	// GetTimezoneHandler sets the operation handler for the get timezone operation
	GetTimezoneHandler GetTimezoneHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

FishHistoryAPI the fish history API

func NewFishHistoryAPI 

func NewFishHistoryAPI(spec *loads.Document) *FishHistoryAPI

NewFishHistoryAPI creates a new FishHistory instance

func (*FishHistoryAPI) AddMiddlewareFor 

func (o *FishHistoryAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*FishHistoryAPI) AuthenticatorsFor 

func (o *FishHistoryAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*FishHistoryAPI) Authorizer 

func (o *FishHistoryAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*FishHistoryAPI) ConsumersFor 

func (o *FishHistoryAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*FishHistoryAPI) Context 

func (o *FishHistoryAPI) Context() *middleware.Context

Context returns the middleware context for the fish history API

func (*FishHistoryAPI) DefaultConsumes 

func (o *FishHistoryAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*FishHistoryAPI) DefaultProduces 

func (o *FishHistoryAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*FishHistoryAPI) Formats 

func (o *FishHistoryAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*FishHistoryAPI) HandlerFor 

func (o *FishHistoryAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*FishHistoryAPI) Init 

func (o *FishHistoryAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*FishHistoryAPI) ProducersFor 

func (o *FishHistoryAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*FishHistoryAPI) RegisterConsumer 

func (o *FishHistoryAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*FishHistoryAPI) RegisterFormat 

func (o *FishHistoryAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*FishHistoryAPI) RegisterProducer 

func (o *FishHistoryAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*FishHistoryAPI) Serve 

func (o *FishHistoryAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*FishHistoryAPI) ServeErrorFor 

func (o *FishHistoryAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*FishHistoryAPI) SetDefaultConsumes 

func (o *FishHistoryAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*FishHistoryAPI) SetDefaultProduces 

func (o *FishHistoryAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*FishHistoryAPI) SetSpec 

func (o *FishHistoryAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*FishHistoryAPI) UseRedoc 

func (o *FishHistoryAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*FishHistoryAPI) UseSwaggerUI 

func (o *FishHistoryAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*FishHistoryAPI) Validate 

func (o *FishHistoryAPI) Validate() error

Validate validates the registrations in the FishHistoryAPI

type GetTimezone 

type GetTimezone struct {
	Context *middleware.Context
	Handler GetTimezoneHandler
}
GetTimezone swagger:route GET /timezone getTimezone

GetTimezone get timezone API

func NewGetTimezone 

func NewGetTimezone(ctx *middleware.Context, handler GetTimezoneHandler) *GetTimezone

NewGetTimezone creates a new http.Handler for the get timezone operation

func (*GetTimezone) ServeHTTP 

func (o *GetTimezone) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type GetTimezoneBadRequest 

type GetTimezoneBadRequest struct {
}

GetTimezoneBadRequest Bad request.

swagger:response getTimezoneBadRequest

func NewGetTimezoneBadRequest 

func NewGetTimezoneBadRequest() *GetTimezoneBadRequest

NewGetTimezoneBadRequest creates GetTimezoneBadRequest with default headers values

func (*GetTimezoneBadRequest) WriteResponse 

func (o *GetTimezoneBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetTimezoneHandler 

type GetTimezoneHandler interface {
	Handle(GetTimezoneParams) middleware.Responder
}

GetTimezoneHandler interface for that can handle valid get timezone params

type GetTimezoneHandlerFunc 

type GetTimezoneHandlerFunc func(GetTimezoneParams) middleware.Responder

GetTimezoneHandlerFunc turns a function with the right signature into a get timezone handler

func (GetTimezoneHandlerFunc) Handle 

func (fn GetTimezoneHandlerFunc) Handle(params GetTimezoneParams) middleware.Responder

Handle executing the request and returning a response

type GetTimezoneOK 

type GetTimezoneOK struct {

	/*
	  In: Body
	*/
	Payload *models.TimezoneResponse `json:"body,omitempty"`
}

GetTimezoneOK Timezone used in server.

swagger:response getTimezoneOK

func NewGetTimezoneOK 

func NewGetTimezoneOK() *GetTimezoneOK

NewGetTimezoneOK creates GetTimezoneOK with default headers values

func (*GetTimezoneOK) SetPayload 

func (o *GetTimezoneOK) SetPayload(payload *models.TimezoneResponse)

SetPayload sets the payload to the get timezone o k response

func (*GetTimezoneOK) WithPayload 

func (o *GetTimezoneOK) WithPayload(payload *models.TimezoneResponse) *GetTimezoneOK

WithPayload adds the payload to the get timezone o k response

func (*GetTimezoneOK) WriteResponse 

func (o *GetTimezoneOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetTimezoneParams 

type GetTimezoneParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

GetTimezoneParams contains all the bound params for the get timezone operation typically these are obtained from a http.Request

swagger:parameters getTimezone

func NewGetTimezoneParams 

func NewGetTimezoneParams() GetTimezoneParams

NewGetTimezoneParams creates a new GetTimezoneParams object

There are no default values defined in the spec.

func (*GetTimezoneParams) BindRequest 

func (o *GetTimezoneParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewGetTimezoneParams() beforehand.

type GetTimezoneURL 

type GetTimezoneURL struct {
	// contains filtered or unexported fields
}

GetTimezoneURL generates an URL for the get timezone operation

func (*GetTimezoneURL) Build 

func (o *GetTimezoneURL) Build() (*url.URL, error)

Build a url path and query string

func (*GetTimezoneURL) BuildFull 

func (o *GetTimezoneURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*GetTimezoneURL) Must 

func (o *GetTimezoneURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*GetTimezoneURL) SetBasePath 

func (o *GetTimezoneURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*GetTimezoneURL) String 

func (o *GetTimezoneURL) String() string

String returns the string representation of the path with query string

func (*GetTimezoneURL) StringFull 

func (o *GetTimezoneURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*GetTimezoneURL) WithBasePath 

func (o *GetTimezoneURL) WithBasePath(bp string) *GetTimezoneURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

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.