enrollment

package
v0.20.119 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const DeleteEnrollmentBadRequestCode int = 400

DeleteEnrollmentBadRequestCode is the HTTP code returned for type DeleteEnrollmentBadRequest

View Source
const DeleteEnrollmentOKCode int = 200

DeleteEnrollmentOKCode is the HTTP code returned for type DeleteEnrollmentOK

View Source
const DeleteEnrollmentUnauthorizedCode int = 401

DeleteEnrollmentUnauthorizedCode is the HTTP code returned for type DeleteEnrollmentUnauthorized

View Source
const DetailEnrollmentNotFoundCode int = 404

DetailEnrollmentNotFoundCode is the HTTP code returned for type DetailEnrollmentNotFound

View Source
const DetailEnrollmentOKCode int = 200

DetailEnrollmentOKCode is the HTTP code returned for type DetailEnrollmentOK

View Source
const DetailEnrollmentUnauthorizedCode int = 401

DetailEnrollmentUnauthorizedCode is the HTTP code returned for type DetailEnrollmentUnauthorized

View Source
const ListEnrollmentsBadRequestCode int = 400

ListEnrollmentsBadRequestCode is the HTTP code returned for type ListEnrollmentsBadRequest

View Source
const ListEnrollmentsOKCode int = 200

ListEnrollmentsOKCode is the HTTP code returned for type ListEnrollmentsOK

View Source
const ListEnrollmentsUnauthorizedCode int = 401

ListEnrollmentsUnauthorizedCode is the HTTP code returned for type ListEnrollmentsUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type DeleteEnrollment

type DeleteEnrollment struct {
	Context *middleware.Context
	Handler DeleteEnrollmentHandler
}
DeleteEnrollment swagger:route DELETE /enrollments/{id} Enrollment deleteEnrollment

Delete an outstanding enrollment

Delete an outstanding enrollment by id. Requires admin access.

func NewDeleteEnrollment

func NewDeleteEnrollment(ctx *middleware.Context, handler DeleteEnrollmentHandler) *DeleteEnrollment

NewDeleteEnrollment creates a new http.Handler for the delete enrollment operation

func (*DeleteEnrollment) ServeHTTP

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

type DeleteEnrollmentBadRequest

type DeleteEnrollmentBadRequest struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DeleteEnrollmentBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

swagger:response deleteEnrollmentBadRequest

func NewDeleteEnrollmentBadRequest

func NewDeleteEnrollmentBadRequest() *DeleteEnrollmentBadRequest

NewDeleteEnrollmentBadRequest creates DeleteEnrollmentBadRequest with default headers values

func (*DeleteEnrollmentBadRequest) SetPayload

func (o *DeleteEnrollmentBadRequest) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the delete enrollment bad request response

func (*DeleteEnrollmentBadRequest) WithPayload

WithPayload adds the payload to the delete enrollment bad request response

func (*DeleteEnrollmentBadRequest) WriteResponse

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

WriteResponse to the client

type DeleteEnrollmentHandler

type DeleteEnrollmentHandler interface {
	Handle(DeleteEnrollmentParams, interface{}) middleware.Responder
}

DeleteEnrollmentHandler interface for that can handle valid delete enrollment params

type DeleteEnrollmentHandlerFunc

type DeleteEnrollmentHandlerFunc func(DeleteEnrollmentParams, interface{}) middleware.Responder

DeleteEnrollmentHandlerFunc turns a function with the right signature into a delete enrollment handler

func (DeleteEnrollmentHandlerFunc) Handle

func (fn DeleteEnrollmentHandlerFunc) Handle(params DeleteEnrollmentParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type DeleteEnrollmentOK

type DeleteEnrollmentOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.Empty `json:"body,omitempty"`
}

DeleteEnrollmentOK The delete request was successful and the resource has been removed

swagger:response deleteEnrollmentOK

func NewDeleteEnrollmentOK

func NewDeleteEnrollmentOK() *DeleteEnrollmentOK

NewDeleteEnrollmentOK creates DeleteEnrollmentOK with default headers values

func (*DeleteEnrollmentOK) SetPayload

func (o *DeleteEnrollmentOK) SetPayload(payload *rest_model.Empty)

SetPayload sets the payload to the delete enrollment o k response

func (*DeleteEnrollmentOK) WithPayload

func (o *DeleteEnrollmentOK) WithPayload(payload *rest_model.Empty) *DeleteEnrollmentOK

WithPayload adds the payload to the delete enrollment o k response

func (*DeleteEnrollmentOK) WriteResponse

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

WriteResponse to the client

type DeleteEnrollmentParams

type DeleteEnrollmentParams struct {

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

	/*The id of the requested resource
	  Required: true
	  In: path
	*/
	ID string
}

DeleteEnrollmentParams contains all the bound params for the delete enrollment operation typically these are obtained from a http.Request

swagger:parameters deleteEnrollment

func NewDeleteEnrollmentParams

func NewDeleteEnrollmentParams() DeleteEnrollmentParams

NewDeleteEnrollmentParams creates a new DeleteEnrollmentParams object

There are no default values defined in the spec.

func (*DeleteEnrollmentParams) BindRequest

func (o *DeleteEnrollmentParams) 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 NewDeleteEnrollmentParams() beforehand.

type DeleteEnrollmentURL

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

DeleteEnrollmentURL generates an URL for the delete enrollment operation

func (*DeleteEnrollmentURL) Build

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

Build a url path and query string

func (*DeleteEnrollmentURL) BuildFull

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

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

func (*DeleteEnrollmentURL) Must

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

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

func (*DeleteEnrollmentURL) SetBasePath

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

func (o *DeleteEnrollmentURL) String() string

String returns the string representation of the path with query string

func (*DeleteEnrollmentURL) StringFull

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

StringFull returns the string representation of a complete url

func (*DeleteEnrollmentURL) WithBasePath

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

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 DeleteEnrollmentUnauthorized

type DeleteEnrollmentUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DeleteEnrollmentUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response deleteEnrollmentUnauthorized

func NewDeleteEnrollmentUnauthorized

func NewDeleteEnrollmentUnauthorized() *DeleteEnrollmentUnauthorized

NewDeleteEnrollmentUnauthorized creates DeleteEnrollmentUnauthorized with default headers values

func (*DeleteEnrollmentUnauthorized) SetPayload

SetPayload sets the payload to the delete enrollment unauthorized response

func (*DeleteEnrollmentUnauthorized) WithPayload

WithPayload adds the payload to the delete enrollment unauthorized response

func (*DeleteEnrollmentUnauthorized) WriteResponse

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

WriteResponse to the client

type DetailEnrollment

type DetailEnrollment struct {
	Context *middleware.Context
	Handler DetailEnrollmentHandler
}
DetailEnrollment swagger:route GET /enrollments/{id} Enrollment detailEnrollment

Retrieves an outstanding enrollment

Retrieves a single outstanding enrollment by id. Requires admin access.

func NewDetailEnrollment

func NewDetailEnrollment(ctx *middleware.Context, handler DetailEnrollmentHandler) *DetailEnrollment

NewDetailEnrollment creates a new http.Handler for the detail enrollment operation

func (*DetailEnrollment) ServeHTTP

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

type DetailEnrollmentHandler

type DetailEnrollmentHandler interface {
	Handle(DetailEnrollmentParams, interface{}) middleware.Responder
}

DetailEnrollmentHandler interface for that can handle valid detail enrollment params

type DetailEnrollmentHandlerFunc

type DetailEnrollmentHandlerFunc func(DetailEnrollmentParams, interface{}) middleware.Responder

DetailEnrollmentHandlerFunc turns a function with the right signature into a detail enrollment handler

func (DetailEnrollmentHandlerFunc) Handle

func (fn DetailEnrollmentHandlerFunc) Handle(params DetailEnrollmentParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type DetailEnrollmentNotFound

type DetailEnrollmentNotFound struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DetailEnrollmentNotFound The requested resource does not exist

swagger:response detailEnrollmentNotFound

func NewDetailEnrollmentNotFound

func NewDetailEnrollmentNotFound() *DetailEnrollmentNotFound

NewDetailEnrollmentNotFound creates DetailEnrollmentNotFound with default headers values

func (*DetailEnrollmentNotFound) SetPayload

func (o *DetailEnrollmentNotFound) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the detail enrollment not found response

func (*DetailEnrollmentNotFound) WithPayload

WithPayload adds the payload to the detail enrollment not found response

func (*DetailEnrollmentNotFound) WriteResponse

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

WriteResponse to the client

type DetailEnrollmentOK

type DetailEnrollmentOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.DetailEnrollmentEnvelope `json:"body,omitempty"`
}

DetailEnrollmentOK A singular enrollment resource

swagger:response detailEnrollmentOK

func NewDetailEnrollmentOK

func NewDetailEnrollmentOK() *DetailEnrollmentOK

NewDetailEnrollmentOK creates DetailEnrollmentOK with default headers values

func (*DetailEnrollmentOK) SetPayload

func (o *DetailEnrollmentOK) SetPayload(payload *rest_model.DetailEnrollmentEnvelope)

SetPayload sets the payload to the detail enrollment o k response

func (*DetailEnrollmentOK) WithPayload

WithPayload adds the payload to the detail enrollment o k response

func (*DetailEnrollmentOK) WriteResponse

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

WriteResponse to the client

type DetailEnrollmentParams

type DetailEnrollmentParams struct {

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

	/*The id of the requested resource
	  Required: true
	  In: path
	*/
	ID string
}

DetailEnrollmentParams contains all the bound params for the detail enrollment operation typically these are obtained from a http.Request

swagger:parameters detailEnrollment

func NewDetailEnrollmentParams

func NewDetailEnrollmentParams() DetailEnrollmentParams

NewDetailEnrollmentParams creates a new DetailEnrollmentParams object

There are no default values defined in the spec.

func (*DetailEnrollmentParams) BindRequest

func (o *DetailEnrollmentParams) 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 NewDetailEnrollmentParams() beforehand.

type DetailEnrollmentURL

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

DetailEnrollmentURL generates an URL for the detail enrollment operation

func (*DetailEnrollmentURL) Build

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

Build a url path and query string

func (*DetailEnrollmentURL) BuildFull

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

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

func (*DetailEnrollmentURL) Must

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

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

func (*DetailEnrollmentURL) SetBasePath

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

func (o *DetailEnrollmentURL) String() string

String returns the string representation of the path with query string

func (*DetailEnrollmentURL) StringFull

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

StringFull returns the string representation of a complete url

func (*DetailEnrollmentURL) WithBasePath

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

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 DetailEnrollmentUnauthorized

type DetailEnrollmentUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

DetailEnrollmentUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response detailEnrollmentUnauthorized

func NewDetailEnrollmentUnauthorized

func NewDetailEnrollmentUnauthorized() *DetailEnrollmentUnauthorized

NewDetailEnrollmentUnauthorized creates DetailEnrollmentUnauthorized with default headers values

func (*DetailEnrollmentUnauthorized) SetPayload

SetPayload sets the payload to the detail enrollment unauthorized response

func (*DetailEnrollmentUnauthorized) WithPayload

WithPayload adds the payload to the detail enrollment unauthorized response

func (*DetailEnrollmentUnauthorized) WriteResponse

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

WriteResponse to the client

type ListEnrollments

type ListEnrollments struct {
	Context *middleware.Context
	Handler ListEnrollmentsHandler
}
ListEnrollments swagger:route GET /enrollments Enrollment listEnrollments

List outstanding enrollments

Retrieves a list of outstanding enrollments; supports filtering, sorting, and pagination. Requires admin access.

func NewListEnrollments

func NewListEnrollments(ctx *middleware.Context, handler ListEnrollmentsHandler) *ListEnrollments

NewListEnrollments creates a new http.Handler for the list enrollments operation

func (*ListEnrollments) ServeHTTP

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

type ListEnrollmentsBadRequest added in v0.19.176

type ListEnrollmentsBadRequest struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

ListEnrollmentsBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies). The error's code, message, and cause fields can be inspected for further information

swagger:response listEnrollmentsBadRequest

func NewListEnrollmentsBadRequest added in v0.19.176

func NewListEnrollmentsBadRequest() *ListEnrollmentsBadRequest

NewListEnrollmentsBadRequest creates ListEnrollmentsBadRequest with default headers values

func (*ListEnrollmentsBadRequest) SetPayload added in v0.19.176

func (o *ListEnrollmentsBadRequest) SetPayload(payload *rest_model.APIErrorEnvelope)

SetPayload sets the payload to the list enrollments bad request response

func (*ListEnrollmentsBadRequest) WithPayload added in v0.19.176

WithPayload adds the payload to the list enrollments bad request response

func (*ListEnrollmentsBadRequest) WriteResponse added in v0.19.176

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

WriteResponse to the client

type ListEnrollmentsHandler

type ListEnrollmentsHandler interface {
	Handle(ListEnrollmentsParams, interface{}) middleware.Responder
}

ListEnrollmentsHandler interface for that can handle valid list enrollments params

type ListEnrollmentsHandlerFunc

type ListEnrollmentsHandlerFunc func(ListEnrollmentsParams, interface{}) middleware.Responder

ListEnrollmentsHandlerFunc turns a function with the right signature into a list enrollments handler

func (ListEnrollmentsHandlerFunc) Handle

func (fn ListEnrollmentsHandlerFunc) Handle(params ListEnrollmentsParams, principal interface{}) middleware.Responder

Handle executing the request and returning a response

type ListEnrollmentsOK

type ListEnrollmentsOK struct {

	/*
	  In: Body
	*/
	Payload *rest_model.ListEnrollmentsEnvelope `json:"body,omitempty"`
}

ListEnrollmentsOK A list of enrollments

swagger:response listEnrollmentsOK

func NewListEnrollmentsOK

func NewListEnrollmentsOK() *ListEnrollmentsOK

NewListEnrollmentsOK creates ListEnrollmentsOK with default headers values

func (*ListEnrollmentsOK) SetPayload

func (o *ListEnrollmentsOK) SetPayload(payload *rest_model.ListEnrollmentsEnvelope)

SetPayload sets the payload to the list enrollments o k response

func (*ListEnrollmentsOK) WithPayload

WithPayload adds the payload to the list enrollments o k response

func (*ListEnrollmentsOK) WriteResponse

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

WriteResponse to the client

type ListEnrollmentsParams

type ListEnrollmentsParams struct {

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

	/*
	  In: query
	*/
	Filter *string
	/*
	  In: query
	*/
	Limit *int64
	/*
	  In: query
	*/
	Offset *int64
}

ListEnrollmentsParams contains all the bound params for the list enrollments operation typically these are obtained from a http.Request

swagger:parameters listEnrollments

func NewListEnrollmentsParams

func NewListEnrollmentsParams() ListEnrollmentsParams

NewListEnrollmentsParams creates a new ListEnrollmentsParams object

There are no default values defined in the spec.

func (*ListEnrollmentsParams) BindRequest

func (o *ListEnrollmentsParams) 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 NewListEnrollmentsParams() beforehand.

type ListEnrollmentsURL

type ListEnrollmentsURL struct {
	Filter *string
	Limit  *int64
	Offset *int64
	// contains filtered or unexported fields
}

ListEnrollmentsURL generates an URL for the list enrollments operation

func (*ListEnrollmentsURL) Build

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

Build a url path and query string

func (*ListEnrollmentsURL) BuildFull

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

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

func (*ListEnrollmentsURL) Must

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

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

func (*ListEnrollmentsURL) SetBasePath

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

func (o *ListEnrollmentsURL) String() string

String returns the string representation of the path with query string

func (*ListEnrollmentsURL) StringFull

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

StringFull returns the string representation of a complete url

func (*ListEnrollmentsURL) WithBasePath

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

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 ListEnrollmentsUnauthorized

type ListEnrollmentsUnauthorized struct {

	/*
	  In: Body
	*/
	Payload *rest_model.APIErrorEnvelope `json:"body,omitempty"`
}

ListEnrollmentsUnauthorized The currently supplied session does not have the correct access rights to request this resource

swagger:response listEnrollmentsUnauthorized

func NewListEnrollmentsUnauthorized

func NewListEnrollmentsUnauthorized() *ListEnrollmentsUnauthorized

NewListEnrollmentsUnauthorized creates ListEnrollmentsUnauthorized with default headers values

func (*ListEnrollmentsUnauthorized) SetPayload

SetPayload sets the payload to the list enrollments unauthorized response

func (*ListEnrollmentsUnauthorized) WithPayload

WithPayload adds the payload to the list enrollments unauthorized response

func (*ListEnrollmentsUnauthorized) WriteResponse

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

WriteResponse to the client

Jump to

Keyboard shortcuts

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