operations

package
v0.0.0-...-39ed591 Latest Latest
Warning

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

Go to latest
Published: Mar 26, 2021 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// GetLighthouseOKBodyStateOn captures enum value "on"
	GetLighthouseOKBodyStateOn string = "on"

	// GetLighthouseOKBodyStateOff captures enum value "off"
	GetLighthouseOKBodyStateOff string = "off"

	// GetLighthouseOKBodyStateBooting captures enum value "booting"
	GetLighthouseOKBodyStateBooting string = "booting"

	// GetLighthouseOKBodyStateUnknown captures enum value "unknown"
	GetLighthouseOKBodyStateUnknown string = "unknown"
)
View Source
const (

	// PostLighthouseStateOKBodyStateOn captures enum value "on"
	PostLighthouseStateOKBodyStateOn string = "on"

	// PostLighthouseStateOKBodyStateOff captures enum value "off"
	PostLighthouseStateOKBodyStateOff string = "off"

	// PostLighthouseStateOKBodyStateBooting captures enum value "booting"
	PostLighthouseStateOKBodyStateBooting string = "booting"

	// PostLighthouseStateOKBodyStateUnknown captures enum value "unknown"
	PostLighthouseStateOKBodyStateUnknown string = "unknown"
)
View Source
const (

	// PostScanOKBodyStateOn captures enum value "on"
	PostScanOKBodyStateOn string = "on"

	// PostScanOKBodyStateOff captures enum value "off"
	PostScanOKBodyStateOff string = "off"

	// PostScanOKBodyStateBooting captures enum value "booting"
	PostScanOKBodyStateBooting string = "booting"

	// PostScanOKBodyStateUnknown captures enum value "unknown"
	PostScanOKBodyStateUnknown string = "unknown"
)
View Source
const GetLighthouseOKCode int = 200

GetLighthouseOKCode is the HTTP code returned for type GetLighthouseOK

View Source
const PostLighthouseStateBadRequestCode int = 400

PostLighthouseStateBadRequestCode is the HTTP code returned for type PostLighthouseStateBadRequest

View Source
const PostLighthouseStateOKCode int = 200

PostLighthouseStateOKCode is the HTTP code returned for type PostLighthouseStateOK

View Source
const PostLighthouseStateTooManyRequestsCode int = 429

PostLighthouseStateTooManyRequestsCode is the HTTP code returned for type PostLighthouseStateTooManyRequests

View Source
const PostScanBadRequestCode int = 400

PostScanBadRequestCode is the HTTP code returned for type PostScanBadRequest

View Source
const PostScanOKCode int = 200

PostScanOKCode is the HTTP code returned for type PostScanOK

View Source
const PostScanTooManyRequestsCode int = 429

PostScanTooManyRequestsCode is the HTTP code returned for type PostScanTooManyRequests

Variables

This section is empty.

Functions

This section is empty.

Types

type GetLighthouse

type GetLighthouse struct {
	Context *middleware.Context
	Handler GetLighthouseHandler
}
GetLighthouse swagger:route GET /lighthouse getLighthouse

GetLighthouse get lighthouse API

func NewGetLighthouse

func NewGetLighthouse(ctx *middleware.Context, handler GetLighthouseHandler) *GetLighthouse

NewGetLighthouse creates a new http.Handler for the get lighthouse operation

func (*GetLighthouse) ServeHTTP

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

type GetLighthouseHandler

type GetLighthouseHandler interface {
	Handle(GetLighthouseParams) middleware.Responder
}

GetLighthouseHandler interface for that can handle valid get lighthouse params

type GetLighthouseHandlerFunc

type GetLighthouseHandlerFunc func(GetLighthouseParams) middleware.Responder

GetLighthouseHandlerFunc turns a function with the right signature into a get lighthouse handler

func (GetLighthouseHandlerFunc) Handle

Handle executing the request and returning a response

type GetLighthouseOK

type GetLighthouseOK struct {

	/*
	  In: Body
	*/
	Payload *GetLighthouseOKBody `json:"body,omitempty"`
}

GetLighthouseOK All known lighthouses

swagger:response getLighthouseOK

func NewGetLighthouseOK

func NewGetLighthouseOK() *GetLighthouseOK

NewGetLighthouseOK creates GetLighthouseOK with default headers values

func (*GetLighthouseOK) SetPayload

func (o *GetLighthouseOK) SetPayload(payload *GetLighthouseOKBody)

SetPayload sets the payload to the get lighthouse o k response

func (*GetLighthouseOK) WithPayload

func (o *GetLighthouseOK) WithPayload(payload *GetLighthouseOKBody) *GetLighthouseOK

WithPayload adds the payload to the get lighthouse o k response

func (*GetLighthouseOK) WriteResponse

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

WriteResponse to the client

type GetLighthouseOKBody

type GetLighthouseOKBody struct {

	// MAC Address
	Address string `json:"address,omitempty"`

	// Human readable name
	Name string `json:"name,omitempty"`

	// What state the lighthouse is currently in
	// Enum: [on off booting unknown]
	State string `json:"state,omitempty"`
}

GetLighthouseOKBody get lighthouse o k body

swagger:model GetLighthouseOKBody

func (*GetLighthouseOKBody) ContextValidate

func (o *GetLighthouseOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this get lighthouse o k body based on context it is used

func (*GetLighthouseOKBody) MarshalBinary

func (o *GetLighthouseOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GetLighthouseOKBody) UnmarshalBinary

func (o *GetLighthouseOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetLighthouseOKBody) Validate

func (o *GetLighthouseOKBody) Validate(formats strfmt.Registry) error

Validate validates this get lighthouse o k body

type GetLighthouseParams

type GetLighthouseParams struct {

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

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

swagger:parameters GetLighthouse

func NewGetLighthouseParams

func NewGetLighthouseParams() GetLighthouseParams

NewGetLighthouseParams creates a new GetLighthouseParams object

There are no default values defined in the spec.

func (*GetLighthouseParams) BindRequest

func (o *GetLighthouseParams) 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 NewGetLighthouseParams() beforehand.

type GetLighthouseURL

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

GetLighthouseURL generates an URL for the get lighthouse operation

func (*GetLighthouseURL) Build

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

Build a url path and query string

func (*GetLighthouseURL) BuildFull

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

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

func (*GetLighthouseURL) Must

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

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

func (*GetLighthouseURL) SetBasePath

func (o *GetLighthouseURL) 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 (*GetLighthouseURL) String

func (o *GetLighthouseURL) String() string

String returns the string representation of the path with query string

func (*GetLighthouseURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetLighthouseURL) WithBasePath

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

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 LighthouseAPIAPI

type LighthouseAPIAPI 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

	// GetLighthouseHandler sets the operation handler for the get lighthouse operation
	GetLighthouseHandler GetLighthouseHandler
	// PostLighthouseStateHandler sets the operation handler for the post lighthouse state operation
	PostLighthouseStateHandler PostLighthouseStateHandler
	// PostScanHandler sets the operation handler for the post scan operation
	PostScanHandler PostScanHandler

	// 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
}

LighthouseAPIAPI the lighthouse API API

func NewLighthouseAPIAPI

func NewLighthouseAPIAPI(spec *loads.Document) *LighthouseAPIAPI

NewLighthouseAPIAPI creates a new LighthouseAPI instance

func (*LighthouseAPIAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*LighthouseAPIAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*LighthouseAPIAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*LighthouseAPIAPI) ConsumersFor

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

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

func (*LighthouseAPIAPI) Context

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

Context returns the middleware context for the lighthouse API API

func (*LighthouseAPIAPI) DefaultConsumes

func (o *LighthouseAPIAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*LighthouseAPIAPI) DefaultProduces

func (o *LighthouseAPIAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*LighthouseAPIAPI) Formats

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

Formats returns the registered string formats

func (*LighthouseAPIAPI) HandlerFor

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

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

func (*LighthouseAPIAPI) Init

func (o *LighthouseAPIAPI) Init()

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

func (*LighthouseAPIAPI) ProducersFor

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

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

func (*LighthouseAPIAPI) RegisterConsumer

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

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

func (*LighthouseAPIAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*LighthouseAPIAPI) RegisterProducer

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

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

func (*LighthouseAPIAPI) Serve

func (o *LighthouseAPIAPI) 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 (*LighthouseAPIAPI) ServeErrorFor

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

ServeErrorFor gets a error handler for a given operation id

func (*LighthouseAPIAPI) SetDefaultConsumes

func (o *LighthouseAPIAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*LighthouseAPIAPI) SetDefaultProduces

func (o *LighthouseAPIAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*LighthouseAPIAPI) SetSpec

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

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

func (*LighthouseAPIAPI) UseRedoc

func (o *LighthouseAPIAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*LighthouseAPIAPI) UseSwaggerUI

func (o *LighthouseAPIAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*LighthouseAPIAPI) Validate

func (o *LighthouseAPIAPI) Validate() error

Validate validates the registrations in the LighthouseAPIAPI

type PostLighthouseState

type PostLighthouseState struct {
	Context *middleware.Context
	Handler PostLighthouseStateHandler
}
PostLighthouseState swagger:route POST /lighthouse/state postLighthouseState

PostLighthouseState post lighthouse state API

func NewPostLighthouseState

func NewPostLighthouseState(ctx *middleware.Context, handler PostLighthouseStateHandler) *PostLighthouseState

NewPostLighthouseState creates a new http.Handler for the post lighthouse state operation

func (*PostLighthouseState) ServeHTTP

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

type PostLighthouseStateBadRequest

type PostLighthouseStateBadRequest struct {

	/*
	  In: Body
	*/
	Payload *PostLighthouseStateBadRequestBody `json:"body,omitempty"`
}

PostLighthouseStateBadRequest Malformed request

swagger:response postLighthouseStateBadRequest

func NewPostLighthouseStateBadRequest

func NewPostLighthouseStateBadRequest() *PostLighthouseStateBadRequest

NewPostLighthouseStateBadRequest creates PostLighthouseStateBadRequest with default headers values

func (*PostLighthouseStateBadRequest) SetPayload

SetPayload sets the payload to the post lighthouse state bad request response

func (*PostLighthouseStateBadRequest) WithPayload

WithPayload adds the payload to the post lighthouse state bad request response

func (*PostLighthouseStateBadRequest) WriteResponse

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

WriteResponse to the client

type PostLighthouseStateBadRequestBody

type PostLighthouseStateBadRequestBody struct {

	// message
	Message string `json:"message,omitempty"`
}

PostLighthouseStateBadRequestBody post lighthouse state bad request body

swagger:model PostLighthouseStateBadRequestBody

func (*PostLighthouseStateBadRequestBody) ContextValidate

func (o *PostLighthouseStateBadRequestBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post lighthouse state bad request body based on context it is used

func (*PostLighthouseStateBadRequestBody) MarshalBinary

func (o *PostLighthouseStateBadRequestBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLighthouseStateBadRequestBody) UnmarshalBinary

func (o *PostLighthouseStateBadRequestBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLighthouseStateBadRequestBody) Validate

Validate validates this post lighthouse state bad request body

type PostLighthouseStateBody

type PostLighthouseStateBody struct {

	// address
	Address interface{} `json:"address,omitempty"`

	// state
	State interface{} `json:"state,omitempty"`
}

PostLighthouseStateBody post lighthouse state body

swagger:model PostLighthouseStateBody

func (*PostLighthouseStateBody) ContextValidate

func (o *PostLighthouseStateBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post lighthouse state body based on context it is used

func (*PostLighthouseStateBody) MarshalBinary

func (o *PostLighthouseStateBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLighthouseStateBody) UnmarshalBinary

func (o *PostLighthouseStateBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLighthouseStateBody) Validate

func (o *PostLighthouseStateBody) Validate(formats strfmt.Registry) error

Validate validates this post lighthouse state body

type PostLighthouseStateHandler

type PostLighthouseStateHandler interface {
	Handle(PostLighthouseStateParams) middleware.Responder
}

PostLighthouseStateHandler interface for that can handle valid post lighthouse state params

type PostLighthouseStateHandlerFunc

type PostLighthouseStateHandlerFunc func(PostLighthouseStateParams) middleware.Responder

PostLighthouseStateHandlerFunc turns a function with the right signature into a post lighthouse state handler

func (PostLighthouseStateHandlerFunc) Handle

Handle executing the request and returning a response

type PostLighthouseStateOK

type PostLighthouseStateOK struct {

	/*
	  In: Body
	*/
	Payload *PostLighthouseStateOKBody `json:"body,omitempty"`
}

PostLighthouseStateOK State changed successfully

swagger:response postLighthouseStateOK

func NewPostLighthouseStateOK

func NewPostLighthouseStateOK() *PostLighthouseStateOK

NewPostLighthouseStateOK creates PostLighthouseStateOK with default headers values

func (*PostLighthouseStateOK) SetPayload

func (o *PostLighthouseStateOK) SetPayload(payload *PostLighthouseStateOKBody)

SetPayload sets the payload to the post lighthouse state o k response

func (*PostLighthouseStateOK) WithPayload

WithPayload adds the payload to the post lighthouse state o k response

func (*PostLighthouseStateOK) WriteResponse

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

WriteResponse to the client

type PostLighthouseStateOKBody

type PostLighthouseStateOKBody struct {

	// MAC Address
	Address string `json:"address,omitempty"`

	// Human readable name
	Name string `json:"name,omitempty"`

	// What state the lighthouse is currently in
	// Enum: [on off booting unknown]
	State string `json:"state,omitempty"`
}

PostLighthouseStateOKBody post lighthouse state o k body

swagger:model PostLighthouseStateOKBody

func (*PostLighthouseStateOKBody) ContextValidate

func (o *PostLighthouseStateOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post lighthouse state o k body based on context it is used

func (*PostLighthouseStateOKBody) MarshalBinary

func (o *PostLighthouseStateOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLighthouseStateOKBody) UnmarshalBinary

func (o *PostLighthouseStateOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLighthouseStateOKBody) Validate

func (o *PostLighthouseStateOKBody) Validate(formats strfmt.Registry) error

Validate validates this post lighthouse state o k body

type PostLighthouseStateParams

type PostLighthouseStateParams struct {

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

	/*
	  In: body
	*/
	Body PostLighthouseStateBody
}

PostLighthouseStateParams contains all the bound params for the post lighthouse state operation typically these are obtained from a http.Request

swagger:parameters PostLighthouseState

func NewPostLighthouseStateParams

func NewPostLighthouseStateParams() PostLighthouseStateParams

NewPostLighthouseStateParams creates a new PostLighthouseStateParams object

There are no default values defined in the spec.

func (*PostLighthouseStateParams) BindRequest

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 NewPostLighthouseStateParams() beforehand.

type PostLighthouseStateTooManyRequests

type PostLighthouseStateTooManyRequests struct {

	/*
	  In: Body
	*/
	Payload *PostLighthouseStateTooManyRequestsBody `json:"body,omitempty"`
}

PostLighthouseStateTooManyRequests Rate limited (can only change state so often)

swagger:response postLighthouseStateTooManyRequests

func NewPostLighthouseStateTooManyRequests

func NewPostLighthouseStateTooManyRequests() *PostLighthouseStateTooManyRequests

NewPostLighthouseStateTooManyRequests creates PostLighthouseStateTooManyRequests with default headers values

func (*PostLighthouseStateTooManyRequests) SetPayload

SetPayload sets the payload to the post lighthouse state too many requests response

func (*PostLighthouseStateTooManyRequests) WithPayload

WithPayload adds the payload to the post lighthouse state too many requests response

func (*PostLighthouseStateTooManyRequests) WriteResponse

WriteResponse to the client

type PostLighthouseStateTooManyRequestsBody

type PostLighthouseStateTooManyRequestsBody struct {

	// message
	Message string `json:"message,omitempty"`
}

PostLighthouseStateTooManyRequestsBody post lighthouse state too many requests body

swagger:model PostLighthouseStateTooManyRequestsBody

func (*PostLighthouseStateTooManyRequestsBody) ContextValidate

ContextValidate validates this post lighthouse state too many requests body based on context it is used

func (*PostLighthouseStateTooManyRequestsBody) MarshalBinary

func (o *PostLighthouseStateTooManyRequestsBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostLighthouseStateTooManyRequestsBody) UnmarshalBinary

func (o *PostLighthouseStateTooManyRequestsBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostLighthouseStateTooManyRequestsBody) Validate

Validate validates this post lighthouse state too many requests body

type PostLighthouseStateURL

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

PostLighthouseStateURL generates an URL for the post lighthouse state operation

func (*PostLighthouseStateURL) Build

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

Build a url path and query string

func (*PostLighthouseStateURL) BuildFull

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

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

func (*PostLighthouseStateURL) Must

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

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

func (*PostLighthouseStateURL) SetBasePath

func (o *PostLighthouseStateURL) 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 (*PostLighthouseStateURL) String

func (o *PostLighthouseStateURL) String() string

String returns the string representation of the path with query string

func (*PostLighthouseStateURL) StringFull

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

StringFull returns the string representation of a complete url

func (*PostLighthouseStateURL) WithBasePath

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 PostScan

type PostScan struct {
	Context *middleware.Context
	Handler PostScanHandler
}
PostScan swagger:route POST /scan postScan

PostScan post scan API

func NewPostScan

func NewPostScan(ctx *middleware.Context, handler PostScanHandler) *PostScan

NewPostScan creates a new http.Handler for the post scan operation

func (*PostScan) ServeHTTP

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

type PostScanBadRequest

type PostScanBadRequest struct {

	/*
	  In: Body
	*/
	Payload *PostScanBadRequestBody `json:"body,omitempty"`
}

PostScanBadRequest Malformed request

swagger:response postScanBadRequest

func NewPostScanBadRequest

func NewPostScanBadRequest() *PostScanBadRequest

NewPostScanBadRequest creates PostScanBadRequest with default headers values

func (*PostScanBadRequest) SetPayload

func (o *PostScanBadRequest) SetPayload(payload *PostScanBadRequestBody)

SetPayload sets the payload to the post scan bad request response

func (*PostScanBadRequest) WithPayload

WithPayload adds the payload to the post scan bad request response

func (*PostScanBadRequest) WriteResponse

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

WriteResponse to the client

type PostScanBadRequestBody

type PostScanBadRequestBody struct {

	// message
	Message string `json:"message,omitempty"`
}

PostScanBadRequestBody post scan bad request body

swagger:model PostScanBadRequestBody

func (*PostScanBadRequestBody) ContextValidate

func (o *PostScanBadRequestBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post scan bad request body based on context it is used

func (*PostScanBadRequestBody) MarshalBinary

func (o *PostScanBadRequestBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostScanBadRequestBody) UnmarshalBinary

func (o *PostScanBadRequestBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostScanBadRequestBody) Validate

func (o *PostScanBadRequestBody) Validate(formats strfmt.Registry) error

Validate validates this post scan bad request body

type PostScanBody

type PostScanBody struct {

	// how long to scan for (in seconds)
	// Maximum: 10
	// Minimum: 1
	Timeout int64 `json:"timeout,omitempty"`
}

PostScanBody post scan body

swagger:model PostScanBody

func (*PostScanBody) ContextValidate

func (o *PostScanBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post scan body based on context it is used

func (*PostScanBody) MarshalBinary

func (o *PostScanBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostScanBody) UnmarshalBinary

func (o *PostScanBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostScanBody) Validate

func (o *PostScanBody) Validate(formats strfmt.Registry) error

Validate validates this post scan body

type PostScanHandler

type PostScanHandler interface {
	Handle(PostScanParams) middleware.Responder
}

PostScanHandler interface for that can handle valid post scan params

type PostScanHandlerFunc

type PostScanHandlerFunc func(PostScanParams) middleware.Responder

PostScanHandlerFunc turns a function with the right signature into a post scan handler

func (PostScanHandlerFunc) Handle

Handle executing the request and returning a response

type PostScanOK

type PostScanOK struct {

	/*
	  In: Body
	*/
	Payload *PostScanOKBody `json:"body,omitempty"`
}

PostScanOK Rescan successfully completed

swagger:response postScanOK

func NewPostScanOK

func NewPostScanOK() *PostScanOK

NewPostScanOK creates PostScanOK with default headers values

func (*PostScanOK) SetPayload

func (o *PostScanOK) SetPayload(payload *PostScanOKBody)

SetPayload sets the payload to the post scan o k response

func (*PostScanOK) WithPayload

func (o *PostScanOK) WithPayload(payload *PostScanOKBody) *PostScanOK

WithPayload adds the payload to the post scan o k response

func (*PostScanOK) WriteResponse

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

WriteResponse to the client

type PostScanOKBody

type PostScanOKBody struct {

	// MAC Address
	Address string `json:"address,omitempty"`

	// Human readable name
	Name string `json:"name,omitempty"`

	// What state the lighthouse is currently in
	// Enum: [on off booting unknown]
	State string `json:"state,omitempty"`
}

PostScanOKBody post scan o k body

swagger:model PostScanOKBody

func (*PostScanOKBody) ContextValidate

func (o *PostScanOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post scan o k body based on context it is used

func (*PostScanOKBody) MarshalBinary

func (o *PostScanOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostScanOKBody) UnmarshalBinary

func (o *PostScanOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostScanOKBody) Validate

func (o *PostScanOKBody) Validate(formats strfmt.Registry) error

Validate validates this post scan o k body

type PostScanParams

type PostScanParams struct {

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

	/*
	  In: body
	*/
	Body PostScanBody
}

PostScanParams contains all the bound params for the post scan operation typically these are obtained from a http.Request

swagger:parameters PostScan

func NewPostScanParams

func NewPostScanParams() PostScanParams

NewPostScanParams creates a new PostScanParams object

There are no default values defined in the spec.

func (*PostScanParams) BindRequest

func (o *PostScanParams) 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 NewPostScanParams() beforehand.

type PostScanTooManyRequests

type PostScanTooManyRequests struct {

	/*
	  In: Body
	*/
	Payload *PostScanTooManyRequestsBody `json:"body,omitempty"`
}

PostScanTooManyRequests Rate limited (can only rescan so often)

swagger:response postScanTooManyRequests

func NewPostScanTooManyRequests

func NewPostScanTooManyRequests() *PostScanTooManyRequests

NewPostScanTooManyRequests creates PostScanTooManyRequests with default headers values

func (*PostScanTooManyRequests) SetPayload

func (o *PostScanTooManyRequests) SetPayload(payload *PostScanTooManyRequestsBody)

SetPayload sets the payload to the post scan too many requests response

func (*PostScanTooManyRequests) WithPayload

WithPayload adds the payload to the post scan too many requests response

func (*PostScanTooManyRequests) WriteResponse

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

WriteResponse to the client

type PostScanTooManyRequestsBody

type PostScanTooManyRequestsBody struct {

	// message
	Message string `json:"message,omitempty"`
}

PostScanTooManyRequestsBody post scan too many requests body

swagger:model PostScanTooManyRequestsBody

func (*PostScanTooManyRequestsBody) ContextValidate

func (o *PostScanTooManyRequestsBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this post scan too many requests body based on context it is used

func (*PostScanTooManyRequestsBody) MarshalBinary

func (o *PostScanTooManyRequestsBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostScanTooManyRequestsBody) UnmarshalBinary

func (o *PostScanTooManyRequestsBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostScanTooManyRequestsBody) Validate

func (o *PostScanTooManyRequestsBody) Validate(formats strfmt.Registry) error

Validate validates this post scan too many requests body

type PostScanURL

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

PostScanURL generates an URL for the post scan operation

func (*PostScanURL) Build

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

Build a url path and query string

func (*PostScanURL) BuildFull

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

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

func (*PostScanURL) Must

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

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

func (*PostScanURL) SetBasePath

func (o *PostScanURL) 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 (*PostScanURL) String

func (o *PostScanURL) String() string

String returns the string representation of the path with query string

func (*PostScanURL) StringFull

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

StringFull returns the string representation of a complete url

func (*PostScanURL) WithBasePath

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL