meta

Documentation

Index

• Constants
• type MetaGet
  • func NewMetaGet(ctx *middleware.Context, handler MetaGetHandler) *MetaGet
  • func (o *MetaGet) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type MetaGetForbidden
  • func NewMetaGetForbidden() *MetaGetForbidden
  • func (o *MetaGetForbidden) SetPayload(payload *models.ErrorResponse)
  • func (o *MetaGetForbidden) WithPayload(payload *models.ErrorResponse) *MetaGetForbidden
  • func (o *MetaGetForbidden) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type MetaGetHandler
• type MetaGetHandlerFunc
  • func (fn MetaGetHandlerFunc) Handle(params MetaGetParams, principal *models.Principal) middleware.Responder
• type MetaGetInternalServerError
  • func NewMetaGetInternalServerError() *MetaGetInternalServerError
  • func (o *MetaGetInternalServerError) SetPayload(payload *models.ErrorResponse)
  • func (o *MetaGetInternalServerError) WithPayload(payload *models.ErrorResponse) *MetaGetInternalServerError
  • func (o *MetaGetInternalServerError) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type MetaGetOK
  • func NewMetaGetOK() *MetaGetOK
  • func (o *MetaGetOK) SetPayload(payload *models.Meta)
  • func (o *MetaGetOK) WithPayload(payload *models.Meta) *MetaGetOK
  • func (o *MetaGetOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type MetaGetParams
  • func NewMetaGetParams() MetaGetParams
  • func (o *MetaGetParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type MetaGetURL
  • func (o *MetaGetURL) Build() (*url.URL, error)
  • func (o *MetaGetURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *MetaGetURL) Must(u *url.URL, err error) *url.URL
  • func (o *MetaGetURL) SetBasePath(bp string)
  • func (o *MetaGetURL) String() string
  • func (o *MetaGetURL) StringFull(scheme, host string) string
  • func (o *MetaGetURL) WithBasePath(bp string) *MetaGetURL
• type MetaGetUnauthorized
  • func NewMetaGetUnauthorized() *MetaGetUnauthorized
  • func (o *MetaGetUnauthorized) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

Constants

const MetaGetForbiddenCode int = 403

MetaGetForbiddenCode is the HTTP code returned for type MetaGetForbidden

const MetaGetInternalServerErrorCode int = 500

MetaGetInternalServerErrorCode is the HTTP code returned for type MetaGetInternalServerError

const MetaGetOKCode int = 200

MetaGetOKCode is the HTTP code returned for type MetaGetOK

const MetaGetUnauthorizedCode int = 401

MetaGetUnauthorizedCode is the HTTP code returned for type MetaGetUnauthorized

Types

type MetaGet

type MetaGet struct {
	Context *middleware.Context
	Handler MetaGetHandler
}

MetaGet swagger:route GET /meta meta metaGet

Returns meta information of the current Weaviate instance.

Returns meta information about the server. Can be used to provide information to another Weaviate instance that wants to interact with the current instance.

func NewMetaGet

func NewMetaGet(ctx *middleware.Context, handler MetaGetHandler) *MetaGet

NewMetaGet creates a new http.Handler for the meta get operation

func (*MetaGet) ServeHTTP

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

type MetaGetForbidden

type MetaGetForbidden struct {

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

MetaGetForbidden Forbidden

swagger:response metaGetForbidden

func NewMetaGetForbidden

func NewMetaGetForbidden() *MetaGetForbidden

NewMetaGetForbidden creates MetaGetForbidden with default headers values

func (*MetaGetForbidden) SetPayload

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

SetPayload sets the payload to the meta get forbidden response

func (*MetaGetForbidden) WithPayload

func (o *MetaGetForbidden) WithPayload(payload *models.ErrorResponse) *MetaGetForbidden

WithPayload adds the payload to the meta get forbidden response

func (*MetaGetForbidden) WriteResponse

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

WriteResponse to the client

type MetaGetHandler

type MetaGetHandler interface {
	Handle(MetaGetParams, *models.Principal) middleware.Responder
}

MetaGetHandler interface for that can handle valid meta get params

type MetaGetHandlerFunc

type MetaGetHandlerFunc func(MetaGetParams, *models.Principal) middleware.Responder

MetaGetHandlerFunc turns a function with the right signature into a meta get handler

func (MetaGetHandlerFunc) Handle

func (fn MetaGetHandlerFunc) Handle(params MetaGetParams, principal *models.Principal) middleware.Responder

Handle executing the request and returning a response

type MetaGetInternalServerError

type MetaGetInternalServerError struct {

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

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

swagger:response metaGetInternalServerError

func NewMetaGetInternalServerError

func NewMetaGetInternalServerError() *MetaGetInternalServerError

NewMetaGetInternalServerError creates MetaGetInternalServerError with default headers values

func (*MetaGetInternalServerError) SetPayload

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

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

func (*MetaGetInternalServerError) WithPayload

func (o *MetaGetInternalServerError) WithPayload(payload *models.ErrorResponse) *MetaGetInternalServerError

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

func (*MetaGetInternalServerError) WriteResponse

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

WriteResponse to the client

type MetaGetOK

type MetaGetOK struct {

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

MetaGetOK Successful response.

swagger:response metaGetOK

func NewMetaGetOK

func NewMetaGetOK() *MetaGetOK

NewMetaGetOK creates MetaGetOK with default headers values

func (*MetaGetOK) SetPayload

func (o *MetaGetOK) SetPayload(payload *models.Meta)

SetPayload sets the payload to the meta get o k response

func (*MetaGetOK) WithPayload

func (o *MetaGetOK) WithPayload(payload *models.Meta) *MetaGetOK

WithPayload adds the payload to the meta get o k response

func (*MetaGetOK) WriteResponse

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

WriteResponse to the client

type MetaGetParams

type MetaGetParams struct {

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

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

swagger:parameters meta.get

func NewMetaGetParams

func NewMetaGetParams() MetaGetParams

NewMetaGetParams creates a new MetaGetParams object

There are no default values defined in the spec.

func (*MetaGetParams) BindRequest

func (o *MetaGetParams) 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 NewMetaGetParams() beforehand.

type MetaGetURL

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

MetaGetURL generates an URL for the meta get operation

func (*MetaGetURL) Build

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

Build a url path and query string

func (*MetaGetURL) BuildFull

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

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

func (*MetaGetURL) Must

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

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

func (*MetaGetURL) SetBasePath

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

func (o *MetaGetURL) String() string

String returns the string representation of the path with query string

func (*MetaGetURL) StringFull

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

StringFull returns the string representation of a complete url

func (*MetaGetURL) WithBasePath

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

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 MetaGetUnauthorized

type MetaGetUnauthorized struct {
}

MetaGetUnauthorized Unauthorized or invalid credentials.

swagger:response metaGetUnauthorized

func NewMetaGetUnauthorized

func NewMetaGetUnauthorized() *MetaGetUnauthorized

NewMetaGetUnauthorized creates MetaGetUnauthorized with default headers values

func (*MetaGetUnauthorized) WriteResponse

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

WriteResponse to the client