classifications

package
v1.20.0 Latest Latest
Warning

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

Go to latest
Published: Jul 6, 2023 License: BSD-3-Clause Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const ClassificationsGetForbiddenCode int = 403

ClassificationsGetForbiddenCode is the HTTP code returned for type ClassificationsGetForbidden

View Source
const ClassificationsGetInternalServerErrorCode int = 500

ClassificationsGetInternalServerErrorCode is the HTTP code returned for type ClassificationsGetInternalServerError

View Source
const ClassificationsGetNotFoundCode int = 404

ClassificationsGetNotFoundCode is the HTTP code returned for type ClassificationsGetNotFound

View Source
const ClassificationsGetOKCode int = 200

ClassificationsGetOKCode is the HTTP code returned for type ClassificationsGetOK

View Source
const ClassificationsGetUnauthorizedCode int = 401

ClassificationsGetUnauthorizedCode is the HTTP code returned for type ClassificationsGetUnauthorized

View Source
const ClassificationsPostBadRequestCode int = 400

ClassificationsPostBadRequestCode is the HTTP code returned for type ClassificationsPostBadRequest

View Source
const ClassificationsPostCreatedCode int = 201

ClassificationsPostCreatedCode is the HTTP code returned for type ClassificationsPostCreated

View Source
const ClassificationsPostForbiddenCode int = 403

ClassificationsPostForbiddenCode is the HTTP code returned for type ClassificationsPostForbidden

View Source
const ClassificationsPostInternalServerErrorCode int = 500

ClassificationsPostInternalServerErrorCode is the HTTP code returned for type ClassificationsPostInternalServerError

View Source
const ClassificationsPostUnauthorizedCode int = 401

ClassificationsPostUnauthorizedCode is the HTTP code returned for type ClassificationsPostUnauthorized

Variables

This section is empty.

Functions

This section is empty.

Types

type ClassificationsGet

type ClassificationsGet struct {
	Context *middleware.Context
	Handler ClassificationsGetHandler
}
ClassificationsGet swagger:route GET /classifications/{id} classifications classificationsGet

View previously created classification

Get status, results and metadata of a previously created classification

func NewClassificationsGet

func NewClassificationsGet(ctx *middleware.Context, handler ClassificationsGetHandler) *ClassificationsGet

NewClassificationsGet creates a new http.Handler for the classifications get operation

func (*ClassificationsGet) ServeHTTP

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

type ClassificationsGetForbidden

type ClassificationsGetForbidden struct {

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

ClassificationsGetForbidden Forbidden

swagger:response classificationsGetForbidden

func NewClassificationsGetForbidden

func NewClassificationsGetForbidden() *ClassificationsGetForbidden

NewClassificationsGetForbidden creates ClassificationsGetForbidden with default headers values

func (*ClassificationsGetForbidden) SetPayload

func (o *ClassificationsGetForbidden) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the classifications get forbidden response

func (*ClassificationsGetForbidden) WithPayload

WithPayload adds the payload to the classifications get forbidden response

func (*ClassificationsGetForbidden) WriteResponse

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

WriteResponse to the client

type ClassificationsGetHandler

type ClassificationsGetHandler interface {
	Handle(ClassificationsGetParams, *models.Principal) middleware.Responder
}

ClassificationsGetHandler interface for that can handle valid classifications get params

type ClassificationsGetHandlerFunc

type ClassificationsGetHandlerFunc func(ClassificationsGetParams, *models.Principal) middleware.Responder

ClassificationsGetHandlerFunc turns a function with the right signature into a classifications get handler

func (ClassificationsGetHandlerFunc) Handle

Handle executing the request and returning a response

type ClassificationsGetInternalServerError

type ClassificationsGetInternalServerError struct {

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

ClassificationsGetInternalServerError An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.

swagger:response classificationsGetInternalServerError

func NewClassificationsGetInternalServerError

func NewClassificationsGetInternalServerError() *ClassificationsGetInternalServerError

NewClassificationsGetInternalServerError creates ClassificationsGetInternalServerError with default headers values

func (*ClassificationsGetInternalServerError) SetPayload

SetPayload sets the payload to the classifications get internal server error response

func (*ClassificationsGetInternalServerError) WithPayload

WithPayload adds the payload to the classifications get internal server error response

func (*ClassificationsGetInternalServerError) WriteResponse

WriteResponse to the client

type ClassificationsGetNotFound

type ClassificationsGetNotFound struct {
}

ClassificationsGetNotFound Not Found - Classification does not exist

swagger:response classificationsGetNotFound

func NewClassificationsGetNotFound

func NewClassificationsGetNotFound() *ClassificationsGetNotFound

NewClassificationsGetNotFound creates ClassificationsGetNotFound with default headers values

func (*ClassificationsGetNotFound) WriteResponse

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

WriteResponse to the client

type ClassificationsGetOK

type ClassificationsGetOK struct {

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

ClassificationsGetOK Found the classification, returned as body

swagger:response classificationsGetOK

func NewClassificationsGetOK

func NewClassificationsGetOK() *ClassificationsGetOK

NewClassificationsGetOK creates ClassificationsGetOK with default headers values

func (*ClassificationsGetOK) SetPayload

func (o *ClassificationsGetOK) SetPayload(payload *models.Classification)

SetPayload sets the payload to the classifications get o k response

func (*ClassificationsGetOK) WithPayload

WithPayload adds the payload to the classifications get o k response

func (*ClassificationsGetOK) WriteResponse

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

WriteResponse to the client

type ClassificationsGetParams

type ClassificationsGetParams struct {

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

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

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

swagger:parameters classifications.get

func NewClassificationsGetParams

func NewClassificationsGetParams() ClassificationsGetParams

NewClassificationsGetParams creates a new ClassificationsGetParams object

There are no default values defined in the spec.

func (*ClassificationsGetParams) 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 NewClassificationsGetParams() beforehand.

type ClassificationsGetURL

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

ClassificationsGetURL generates an URL for the classifications get operation

func (*ClassificationsGetURL) Build

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

Build a url path and query string

func (*ClassificationsGetURL) BuildFull

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

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

func (*ClassificationsGetURL) Must

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

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

func (*ClassificationsGetURL) SetBasePath

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

func (o *ClassificationsGetURL) String() string

String returns the string representation of the path with query string

func (*ClassificationsGetURL) StringFull

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

StringFull returns the string representation of a complete url

func (*ClassificationsGetURL) WithBasePath

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

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 ClassificationsGetUnauthorized

type ClassificationsGetUnauthorized struct {
}

ClassificationsGetUnauthorized Unauthorized or invalid credentials.

swagger:response classificationsGetUnauthorized

func NewClassificationsGetUnauthorized

func NewClassificationsGetUnauthorized() *ClassificationsGetUnauthorized

NewClassificationsGetUnauthorized creates ClassificationsGetUnauthorized with default headers values

func (*ClassificationsGetUnauthorized) WriteResponse

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

WriteResponse to the client

type ClassificationsPost

type ClassificationsPost struct {
	Context *middleware.Context
	Handler ClassificationsPostHandler
}
ClassificationsPost swagger:route POST /classifications/ classifications classificationsPost

Starts a classification.

Trigger a classification based on the specified params. Classifications will run in the background, use GET /classifications/<id> to retrieve the status of your classification.

func NewClassificationsPost

func NewClassificationsPost(ctx *middleware.Context, handler ClassificationsPostHandler) *ClassificationsPost

NewClassificationsPost creates a new http.Handler for the classifications post operation

func (*ClassificationsPost) ServeHTTP

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

type ClassificationsPostBadRequest

type ClassificationsPostBadRequest struct {

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

ClassificationsPostBadRequest Incorrect request

swagger:response classificationsPostBadRequest

func NewClassificationsPostBadRequest

func NewClassificationsPostBadRequest() *ClassificationsPostBadRequest

NewClassificationsPostBadRequest creates ClassificationsPostBadRequest with default headers values

func (*ClassificationsPostBadRequest) SetPayload

func (o *ClassificationsPostBadRequest) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the classifications post bad request response

func (*ClassificationsPostBadRequest) WithPayload

WithPayload adds the payload to the classifications post bad request response

func (*ClassificationsPostBadRequest) WriteResponse

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

WriteResponse to the client

type ClassificationsPostCreated

type ClassificationsPostCreated struct {

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

ClassificationsPostCreated Successfully started classification.

swagger:response classificationsPostCreated

func NewClassificationsPostCreated

func NewClassificationsPostCreated() *ClassificationsPostCreated

NewClassificationsPostCreated creates ClassificationsPostCreated with default headers values

func (*ClassificationsPostCreated) SetPayload

func (o *ClassificationsPostCreated) SetPayload(payload *models.Classification)

SetPayload sets the payload to the classifications post created response

func (*ClassificationsPostCreated) WithPayload

WithPayload adds the payload to the classifications post created response

func (*ClassificationsPostCreated) WriteResponse

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

WriteResponse to the client

type ClassificationsPostForbidden

type ClassificationsPostForbidden struct {

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

ClassificationsPostForbidden Forbidden

swagger:response classificationsPostForbidden

func NewClassificationsPostForbidden

func NewClassificationsPostForbidden() *ClassificationsPostForbidden

NewClassificationsPostForbidden creates ClassificationsPostForbidden with default headers values

func (*ClassificationsPostForbidden) SetPayload

func (o *ClassificationsPostForbidden) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the classifications post forbidden response

func (*ClassificationsPostForbidden) WithPayload

WithPayload adds the payload to the classifications post forbidden response

func (*ClassificationsPostForbidden) WriteResponse

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

WriteResponse to the client

type ClassificationsPostHandler

type ClassificationsPostHandler interface {
	Handle(ClassificationsPostParams, *models.Principal) middleware.Responder
}

ClassificationsPostHandler interface for that can handle valid classifications post params

type ClassificationsPostHandlerFunc

type ClassificationsPostHandlerFunc func(ClassificationsPostParams, *models.Principal) middleware.Responder

ClassificationsPostHandlerFunc turns a function with the right signature into a classifications post handler

func (ClassificationsPostHandlerFunc) Handle

Handle executing the request and returning a response

type ClassificationsPostInternalServerError

type ClassificationsPostInternalServerError struct {

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

ClassificationsPostInternalServerError An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.

swagger:response classificationsPostInternalServerError

func NewClassificationsPostInternalServerError

func NewClassificationsPostInternalServerError() *ClassificationsPostInternalServerError

NewClassificationsPostInternalServerError creates ClassificationsPostInternalServerError with default headers values

func (*ClassificationsPostInternalServerError) SetPayload

SetPayload sets the payload to the classifications post internal server error response

func (*ClassificationsPostInternalServerError) WithPayload

WithPayload adds the payload to the classifications post internal server error response

func (*ClassificationsPostInternalServerError) WriteResponse

WriteResponse to the client

type ClassificationsPostParams

type ClassificationsPostParams struct {

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

	/*parameters to start a classification
	  Required: true
	  In: body
	*/
	Params *models.Classification
}

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

swagger:parameters classifications.post

func NewClassificationsPostParams

func NewClassificationsPostParams() ClassificationsPostParams

NewClassificationsPostParams creates a new ClassificationsPostParams object

There are no default values defined in the spec.

func (*ClassificationsPostParams) 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 NewClassificationsPostParams() beforehand.

type ClassificationsPostURL

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

ClassificationsPostURL generates an URL for the classifications post operation

func (*ClassificationsPostURL) Build

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

Build a url path and query string

func (*ClassificationsPostURL) BuildFull

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

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

func (*ClassificationsPostURL) Must

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

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

func (*ClassificationsPostURL) SetBasePath

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

func (o *ClassificationsPostURL) String() string

String returns the string representation of the path with query string

func (*ClassificationsPostURL) StringFull

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

StringFull returns the string representation of a complete url

func (*ClassificationsPostURL) 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 ClassificationsPostUnauthorized

type ClassificationsPostUnauthorized struct {
}

ClassificationsPostUnauthorized Unauthorized or invalid credentials.

swagger:response classificationsPostUnauthorized

func NewClassificationsPostUnauthorized

func NewClassificationsPostUnauthorized() *ClassificationsPostUnauthorized

NewClassificationsPostUnauthorized creates ClassificationsPostUnauthorized with default headers values

func (*ClassificationsPostUnauthorized) WriteResponse

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