Documentation
¶
Index ¶
- Constants
- type ShowQueue
- type ShowQueueBadRequest
- type ShowQueueForbidden
- type ShowQueueHandler
- type ShowQueueHandlerFunc
- type ShowQueueNotFound
- type ShowQueueOK
- type ShowQueueParams
- type ShowQueueURL
- func (o *ShowQueueURL) Build() (*url.URL, error)
- func (o *ShowQueueURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ShowQueueURL) Must(u *url.URL, err error) *url.URL
- func (o *ShowQueueURL) SetBasePath(bp string)
- func (o *ShowQueueURL) String() string
- func (o *ShowQueueURL) StringFull(scheme, host string) string
- func (o *ShowQueueURL) WithBasePath(bp string) *ShowQueueURL
- type ShowQueueUnauthorized
Constants ¶
const ShowQueueBadRequestCode int = 400
ShowQueueBadRequestCode is the HTTP code returned for type ShowQueueBadRequest
const ShowQueueForbiddenCode int = 403
ShowQueueForbiddenCode is the HTTP code returned for type ShowQueueForbidden
const ShowQueueNotFoundCode int = 404
ShowQueueNotFoundCode is the HTTP code returned for type ShowQueueNotFound
const ShowQueueOKCode int = 200
ShowQueueOKCode is the HTTP code returned for type ShowQueueOK
ShowQueueUnauthorizedCode is the HTTP code returned for type ShowQueueUnauthorized
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ShowQueue ¶
type ShowQueue struct {
Context *middleware.Context
Handler ShowQueueHandler
}
ShowQueue swagger:route GET /queues/{queueType} queues showQueue
Show all moves in a queue ¶
Show all moves in a queue
func NewShowQueue ¶
func NewShowQueue(ctx *middleware.Context, handler ShowQueueHandler) *ShowQueue
NewShowQueue creates a new http.Handler for the show queue operation
type ShowQueueBadRequest ¶
type ShowQueueBadRequest struct {
}
ShowQueueBadRequest invalid request
swagger:response showQueueBadRequest
func NewShowQueueBadRequest ¶
func NewShowQueueBadRequest() *ShowQueueBadRequest
NewShowQueueBadRequest creates ShowQueueBadRequest with default headers values
func (*ShowQueueBadRequest) WriteResponse ¶
func (o *ShowQueueBadRequest) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ShowQueueForbidden ¶
type ShowQueueForbidden struct {
}
ShowQueueForbidden user is not authorized to access this queue
swagger:response showQueueForbidden
func NewShowQueueForbidden ¶
func NewShowQueueForbidden() *ShowQueueForbidden
NewShowQueueForbidden creates ShowQueueForbidden with default headers values
func (*ShowQueueForbidden) WriteResponse ¶
func (o *ShowQueueForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ShowQueueHandler ¶
type ShowQueueHandler interface {
Handle(ShowQueueParams) middleware.Responder
}
ShowQueueHandler interface for that can handle valid show queue params
type ShowQueueHandlerFunc ¶
type ShowQueueHandlerFunc func(ShowQueueParams) middleware.Responder
ShowQueueHandlerFunc turns a function with the right signature into a show queue handler
func (ShowQueueHandlerFunc) Handle ¶
func (fn ShowQueueHandlerFunc) Handle(params ShowQueueParams) middleware.Responder
Handle executing the request and returning a response
type ShowQueueNotFound ¶
type ShowQueueNotFound struct {
}
ShowQueueNotFound move queue item is not found
swagger:response showQueueNotFound
func NewShowQueueNotFound ¶
func NewShowQueueNotFound() *ShowQueueNotFound
NewShowQueueNotFound creates ShowQueueNotFound with default headers values
func (*ShowQueueNotFound) WriteResponse ¶
func (o *ShowQueueNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ShowQueueOK ¶
type ShowQueueOK struct {
/*
In: Body
*/
Payload []*internalmessages.MoveQueueItem `json:"body,omitempty"`
}
ShowQueueOK list all moves in the specified queue
swagger:response showQueueOK
func NewShowQueueOK ¶
func NewShowQueueOK() *ShowQueueOK
NewShowQueueOK creates ShowQueueOK with default headers values
func (*ShowQueueOK) SetPayload ¶
func (o *ShowQueueOK) SetPayload(payload []*internalmessages.MoveQueueItem)
SetPayload sets the payload to the show queue o k response
func (*ShowQueueOK) WithPayload ¶
func (o *ShowQueueOK) WithPayload(payload []*internalmessages.MoveQueueItem) *ShowQueueOK
WithPayload adds the payload to the show queue o k response
func (*ShowQueueOK) WriteResponse ¶
func (o *ShowQueueOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ShowQueueParams ¶
type ShowQueueParams struct {
// HTTP Request Object
HTTPRequest *http.Request `json:"-"`
/*Queue type to show
Required: true
In: path
*/
QueueType string
}
ShowQueueParams contains all the bound params for the show queue operation typically these are obtained from a http.Request
swagger:parameters showQueue
func NewShowQueueParams ¶
func NewShowQueueParams() ShowQueueParams
NewShowQueueParams creates a new ShowQueueParams object
There are no default values defined in the spec.
func (*ShowQueueParams) BindRequest ¶
func (o *ShowQueueParams) 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 NewShowQueueParams() beforehand.
type ShowQueueURL ¶
type ShowQueueURL struct {
QueueType string
// contains filtered or unexported fields
}
ShowQueueURL generates an URL for the show queue operation
func (*ShowQueueURL) Build ¶
func (o *ShowQueueURL) Build() (*url.URL, error)
Build a url path and query string
func (*ShowQueueURL) BuildFull ¶
func (o *ShowQueueURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*ShowQueueURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*ShowQueueURL) SetBasePath ¶
func (o *ShowQueueURL) 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 (*ShowQueueURL) String ¶
func (o *ShowQueueURL) String() string
String returns the string representation of the path with query string
func (*ShowQueueURL) StringFull ¶
func (o *ShowQueueURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*ShowQueueURL) WithBasePath ¶
func (o *ShowQueueURL) WithBasePath(bp string) *ShowQueueURL
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 ShowQueueUnauthorized ¶
type ShowQueueUnauthorized struct {
}
ShowQueueUnauthorized request requires user authentication
swagger:response showQueueUnauthorized
func NewShowQueueUnauthorized ¶
func NewShowQueueUnauthorized() *ShowQueueUnauthorized
NewShowQueueUnauthorized creates ShowQueueUnauthorized with default headers values
func (*ShowQueueUnauthorized) WriteResponse ¶
func (o *ShowQueueUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
Source Files