events

package
v4.0.0 Latest Latest
Warning

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

 Go to latest Published: Jul 24, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const GetEventNotFoundCode int = 404

GetEventNotFoundCode is the HTTP code returned for type GetEventNotFound

View Source 
const GetEventOKCode int = 200

GetEventOKCode is the HTTP code returned for type GetEventOK

View Source 
const GetEventsNotFoundCode int = 404

GetEventsNotFoundCode is the HTTP code returned for type GetEventsNotFound

View Source 
const GetEventsOKCode int = 200

GetEventsOKCode is the HTTP code returned for type GetEventsOK

Variables

This section is empty.

Functions

This section is empty.

Types

type GetEvent 

type GetEvent struct {
	Context *middleware.Context
	Handler GetEventHandler
}
GetEvent swagger:route GET /events/{id} Events getEvent

Returns the specific event

func NewGetEvent 

func NewGetEvent(ctx *middleware.Context, handler GetEventHandler) *GetEvent

NewGetEvent creates a new http.Handler for the get event operation

func (*GetEvent) ServeHTTP 

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

type GetEventHandler 

type GetEventHandler interface {
	Handle(GetEventParams, interface{}) middleware.Responder
}

GetEventHandler interface for that can handle valid get event params

type GetEventHandlerFunc 

type GetEventHandlerFunc func(GetEventParams, interface{}) middleware.Responder

GetEventHandlerFunc turns a function with the right signature into a get event handler

func (GetEventHandlerFunc) Handle 

func (fn GetEventHandlerFunc) Handle(params GetEventParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type GetEventNotFound 

type GetEventNotFound struct {

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

GetEventNotFound Entity Not Found

swagger:response getEventNotFound

func NewGetEventNotFound 

func NewGetEventNotFound() *GetEventNotFound

NewGetEventNotFound creates GetEventNotFound with default headers values

func (*GetEventNotFound) SetPayload 

func (o *GetEventNotFound) SetPayload(payload *models.NotFound)

SetPayload sets the payload to the get event not found response

func (*GetEventNotFound) WithPayload 

func (o *GetEventNotFound) WithPayload(payload *models.NotFound) *GetEventNotFound

WithPayload adds the payload to the get event not found response

func (*GetEventNotFound) WriteResponse 

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

WriteResponse to the client

type GetEventOK 

type GetEventOK struct {

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

GetEventOK OK Response

swagger:response getEventOK

func NewGetEventOK 

func NewGetEventOK() *GetEventOK

NewGetEventOK creates GetEventOK with default headers values

func (*GetEventOK) SetPayload 

func (o *GetEventOK) SetPayload(payload *models.EventResponse)

SetPayload sets the payload to the get event o k response

func (*GetEventOK) WithPayload 

func (o *GetEventOK) WithPayload(payload *models.EventResponse) *GetEventOK

WithPayload adds the payload to the get event o k response

func (*GetEventOK) WriteResponse 

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

WriteResponse to the client

type GetEventParams 

type GetEventParams struct {

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

	/*
	  Required: true
	  In: path
	*/
	ID string
}

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

swagger:parameters getEvent

func NewGetEventParams 

func NewGetEventParams() GetEventParams

NewGetEventParams creates a new GetEventParams object

There are no default values defined in the spec.

func (*GetEventParams) BindRequest 

func (o *GetEventParams) 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 NewGetEventParams() beforehand.

type GetEventURL 

type GetEventURL struct {
	ID string
	// contains filtered or unexported fields
}

GetEventURL generates an URL for the get event operation

func (*GetEventURL) Build 

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

Build a url path and query string

func (*GetEventURL) BuildFull 

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

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

func (*GetEventURL) Must 

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

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

func (*GetEventURL) SetBasePath 

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

func (o *GetEventURL) String() string

String returns the string representation of the path with query string

func (*GetEventURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetEventURL) WithBasePath 

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

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 GetEvents 

type GetEvents struct {
	Context *middleware.Context
	Handler GetEventsHandler
}
GetEvents swagger:route GET /events Events getEvents

Returns a list of events

func NewGetEvents 

func NewGetEvents(ctx *middleware.Context, handler GetEventsHandler) *GetEvents

NewGetEvents creates a new http.Handler for the get events operation

func (*GetEvents) ServeHTTP 

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

type GetEventsHandler 

type GetEventsHandler interface {
	Handle(GetEventsParams, interface{}) middleware.Responder
}

GetEventsHandler interface for that can handle valid get events params

type GetEventsHandlerFunc 

type GetEventsHandlerFunc func(GetEventsParams, interface{}) middleware.Responder

GetEventsHandlerFunc turns a function with the right signature into a get events handler

func (GetEventsHandlerFunc) Handle 

func (fn GetEventsHandlerFunc) Handle(params GetEventsParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type GetEventsNotFound 

type GetEventsNotFound struct {

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

GetEventsNotFound Entity Not Found

swagger:response getEventsNotFound

func NewGetEventsNotFound 

func NewGetEventsNotFound() *GetEventsNotFound

NewGetEventsNotFound creates GetEventsNotFound with default headers values

func (*GetEventsNotFound) SetPayload 

func (o *GetEventsNotFound) SetPayload(payload *models.NotFound)

SetPayload sets the payload to the get events not found response

func (*GetEventsNotFound) WithPayload 

func (o *GetEventsNotFound) WithPayload(payload *models.NotFound) *GetEventsNotFound

WithPayload adds the payload to the get events not found response

func (*GetEventsNotFound) WriteResponse 

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

WriteResponse to the client

type GetEventsOK 

type GetEventsOK struct {

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

GetEventsOK OK Response

swagger:response getEventsOK

func NewGetEventsOK 

func NewGetEventsOK() *GetEventsOK

NewGetEventsOK creates GetEventsOK with default headers values

func (*GetEventsOK) SetPayload 

func (o *GetEventsOK) SetPayload(payload *models.EventsResponse)

SetPayload sets the payload to the get events o k response

func (*GetEventsOK) WithPayload 

func (o *GetEventsOK) WithPayload(payload *models.EventsResponse) *GetEventsOK

WithPayload adds the payload to the get events o k response

func (*GetEventsOK) WriteResponse 

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

WriteResponse to the client

type GetEventsParams 

type GetEventsParams struct {

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

	/*
	  In: query
	*/
	EndingBefore *string
	/*
	  In: query
	*/
	Limit *int64
	/*
	  In: query
	  Collection Format: multi
	*/
	RecordType []string
	/*
	  In: query
	*/
	School *string
	/*
	  In: query
	*/
	StartingAfter *string
}

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

swagger:parameters getEvents

func NewGetEventsParams 

func NewGetEventsParams() GetEventsParams

NewGetEventsParams creates a new GetEventsParams object

There are no default values defined in the spec.

func (*GetEventsParams) BindRequest 

func (o *GetEventsParams) 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 NewGetEventsParams() beforehand.

type GetEventsURL 

type GetEventsURL struct {
	EndingBefore  *string
	Limit         *int64
	RecordType    []string
	School        *string
	StartingAfter *string
	// contains filtered or unexported fields
}

GetEventsURL generates an URL for the get events operation

func (*GetEventsURL) Build 

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

Build a url path and query string

func (*GetEventsURL) BuildFull 

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

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

func (*GetEventsURL) Must 

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

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

func (*GetEventsURL) SetBasePath 

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

func (o *GetEventsURL) String() string

String returns the string representation of the path with query string

func (*GetEventsURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetEventsURL) WithBasePath 

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

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.