operations

package
v1.24.10 Latest Latest
Warning

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

Go to latest
Published: Apr 19, 2024 License: BSD-3-Clause Imports: 27 Imported by: 0

Documentation

Index

Constants

View Source
const WeaviateRootOKCode int = 200

WeaviateRootOKCode is the HTTP code returned for type WeaviateRootOK

View Source
const WeaviateWellknownLivenessOKCode int = 200

WeaviateWellknownLivenessOKCode is the HTTP code returned for type WeaviateWellknownLivenessOK

View Source
const WeaviateWellknownReadinessOKCode int = 200

WeaviateWellknownReadinessOKCode is the HTTP code returned for type WeaviateWellknownReadinessOK

View Source
const WeaviateWellknownReadinessServiceUnavailableCode int = 503

WeaviateWellknownReadinessServiceUnavailableCode is the HTTP code returned for type WeaviateWellknownReadinessServiceUnavailable

Variables

This section is empty.

Functions

This section is empty.

Types

type WeaviateAPI

type WeaviateAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator

	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator

	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer
	// YamlConsumer registers a consumer for the following mime types:
	//   - application/yaml
	YamlConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// OidcAuth registers a function that takes an access token and a collection of required scopes and returns a principal
	// it performs authentication based on an oauth2 bearer token provided in the request
	OidcAuth func(string, []string) (*models.Principal, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// WellKnownGetWellKnownOpenidConfigurationHandler sets the operation handler for the get well known openid configuration operation
	WellKnownGetWellKnownOpenidConfigurationHandler well_known.GetWellKnownOpenidConfigurationHandler
	// BackupsBackupsCreateHandler sets the operation handler for the backups create operation
	BackupsBackupsCreateHandler backups.BackupsCreateHandler
	// BackupsBackupsCreateStatusHandler sets the operation handler for the backups create status operation
	BackupsBackupsCreateStatusHandler backups.BackupsCreateStatusHandler
	// BackupsBackupsRestoreHandler sets the operation handler for the backups restore operation
	BackupsBackupsRestoreHandler backups.BackupsRestoreHandler
	// BackupsBackupsRestoreStatusHandler sets the operation handler for the backups restore status operation
	BackupsBackupsRestoreStatusHandler backups.BackupsRestoreStatusHandler
	// BatchBatchObjectsCreateHandler sets the operation handler for the batch objects create operation
	BatchBatchObjectsCreateHandler batch.BatchObjectsCreateHandler
	// BatchBatchObjectsDeleteHandler sets the operation handler for the batch objects delete operation
	BatchBatchObjectsDeleteHandler batch.BatchObjectsDeleteHandler
	// BatchBatchReferencesCreateHandler sets the operation handler for the batch references create operation
	BatchBatchReferencesCreateHandler batch.BatchReferencesCreateHandler
	// ClassificationsClassificationsGetHandler sets the operation handler for the classifications get operation
	ClassificationsClassificationsGetHandler classifications.ClassificationsGetHandler
	// ClassificationsClassificationsPostHandler sets the operation handler for the classifications post operation
	ClassificationsClassificationsPostHandler classifications.ClassificationsPostHandler
	// GraphqlGraphqlBatchHandler sets the operation handler for the graphql batch operation
	GraphqlGraphqlBatchHandler graphql.GraphqlBatchHandler
	// GraphqlGraphqlPostHandler sets the operation handler for the graphql post operation
	GraphqlGraphqlPostHandler graphql.GraphqlPostHandler
	// MetaMetaGetHandler sets the operation handler for the meta get operation
	MetaMetaGetHandler meta.MetaGetHandler
	// NodesNodesGetHandler sets the operation handler for the nodes get operation
	NodesNodesGetHandler nodes.NodesGetHandler
	// NodesNodesGetClassHandler sets the operation handler for the nodes get class operation
	NodesNodesGetClassHandler nodes.NodesGetClassHandler
	// ObjectsObjectsClassDeleteHandler sets the operation handler for the objects class delete operation
	ObjectsObjectsClassDeleteHandler objects.ObjectsClassDeleteHandler
	// ObjectsObjectsClassGetHandler sets the operation handler for the objects class get operation
	ObjectsObjectsClassGetHandler objects.ObjectsClassGetHandler
	// ObjectsObjectsClassHeadHandler sets the operation handler for the objects class head operation
	ObjectsObjectsClassHeadHandler objects.ObjectsClassHeadHandler
	// ObjectsObjectsClassPatchHandler sets the operation handler for the objects class patch operation
	ObjectsObjectsClassPatchHandler objects.ObjectsClassPatchHandler
	// ObjectsObjectsClassPutHandler sets the operation handler for the objects class put operation
	ObjectsObjectsClassPutHandler objects.ObjectsClassPutHandler
	// ObjectsObjectsClassReferencesCreateHandler sets the operation handler for the objects class references create operation
	ObjectsObjectsClassReferencesCreateHandler objects.ObjectsClassReferencesCreateHandler
	// ObjectsObjectsClassReferencesDeleteHandler sets the operation handler for the objects class references delete operation
	ObjectsObjectsClassReferencesDeleteHandler objects.ObjectsClassReferencesDeleteHandler
	// ObjectsObjectsClassReferencesPutHandler sets the operation handler for the objects class references put operation
	ObjectsObjectsClassReferencesPutHandler objects.ObjectsClassReferencesPutHandler
	// ObjectsObjectsCreateHandler sets the operation handler for the objects create operation
	ObjectsObjectsCreateHandler objects.ObjectsCreateHandler
	// ObjectsObjectsDeleteHandler sets the operation handler for the objects delete operation
	ObjectsObjectsDeleteHandler objects.ObjectsDeleteHandler
	// ObjectsObjectsGetHandler sets the operation handler for the objects get operation
	ObjectsObjectsGetHandler objects.ObjectsGetHandler
	// ObjectsObjectsHeadHandler sets the operation handler for the objects head operation
	ObjectsObjectsHeadHandler objects.ObjectsHeadHandler
	// ObjectsObjectsListHandler sets the operation handler for the objects list operation
	ObjectsObjectsListHandler objects.ObjectsListHandler
	// ObjectsObjectsPatchHandler sets the operation handler for the objects patch operation
	ObjectsObjectsPatchHandler objects.ObjectsPatchHandler
	// ObjectsObjectsReferencesCreateHandler sets the operation handler for the objects references create operation
	ObjectsObjectsReferencesCreateHandler objects.ObjectsReferencesCreateHandler
	// ObjectsObjectsReferencesDeleteHandler sets the operation handler for the objects references delete operation
	ObjectsObjectsReferencesDeleteHandler objects.ObjectsReferencesDeleteHandler
	// ObjectsObjectsReferencesUpdateHandler sets the operation handler for the objects references update operation
	ObjectsObjectsReferencesUpdateHandler objects.ObjectsReferencesUpdateHandler
	// ObjectsObjectsUpdateHandler sets the operation handler for the objects update operation
	ObjectsObjectsUpdateHandler objects.ObjectsUpdateHandler
	// ObjectsObjectsValidateHandler sets the operation handler for the objects validate operation
	ObjectsObjectsValidateHandler objects.ObjectsValidateHandler
	// SchemaSchemaClusterStatusHandler sets the operation handler for the schema cluster status operation
	SchemaSchemaClusterStatusHandler schema.SchemaClusterStatusHandler
	// SchemaSchemaDumpHandler sets the operation handler for the schema dump operation
	SchemaSchemaDumpHandler schema.SchemaDumpHandler
	// SchemaSchemaObjectsCreateHandler sets the operation handler for the schema objects create operation
	SchemaSchemaObjectsCreateHandler schema.SchemaObjectsCreateHandler
	// SchemaSchemaObjectsDeleteHandler sets the operation handler for the schema objects delete operation
	SchemaSchemaObjectsDeleteHandler schema.SchemaObjectsDeleteHandler
	// SchemaSchemaObjectsGetHandler sets the operation handler for the schema objects get operation
	SchemaSchemaObjectsGetHandler schema.SchemaObjectsGetHandler
	// SchemaSchemaObjectsPropertiesAddHandler sets the operation handler for the schema objects properties add operation
	SchemaSchemaObjectsPropertiesAddHandler schema.SchemaObjectsPropertiesAddHandler
	// SchemaSchemaObjectsShardsGetHandler sets the operation handler for the schema objects shards get operation
	SchemaSchemaObjectsShardsGetHandler schema.SchemaObjectsShardsGetHandler
	// SchemaSchemaObjectsShardsUpdateHandler sets the operation handler for the schema objects shards update operation
	SchemaSchemaObjectsShardsUpdateHandler schema.SchemaObjectsShardsUpdateHandler
	// SchemaSchemaObjectsUpdateHandler sets the operation handler for the schema objects update operation
	SchemaSchemaObjectsUpdateHandler schema.SchemaObjectsUpdateHandler
	// SchemaTenantsCreateHandler sets the operation handler for the tenants create operation
	SchemaTenantsCreateHandler schema.TenantsCreateHandler
	// SchemaTenantsDeleteHandler sets the operation handler for the tenants delete operation
	SchemaTenantsDeleteHandler schema.TenantsDeleteHandler
	// SchemaTenantsGetHandler sets the operation handler for the tenants get operation
	SchemaTenantsGetHandler schema.TenantsGetHandler
	// SchemaTenantsUpdateHandler sets the operation handler for the tenants update operation
	SchemaTenantsUpdateHandler schema.TenantsUpdateHandler
	// WeaviateRootHandler sets the operation handler for the weaviate root operation
	WeaviateRootHandler WeaviateRootHandler
	// WeaviateWellknownLivenessHandler sets the operation handler for the weaviate wellknown liveness operation
	WeaviateWellknownLivenessHandler WeaviateWellknownLivenessHandler
	// WeaviateWellknownReadinessHandler sets the operation handler for the weaviate wellknown readiness operation
	WeaviateWellknownReadinessHandler WeaviateWellknownReadinessHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

WeaviateAPI Cloud-native, modular vector database

func NewWeaviateAPI

func NewWeaviateAPI(spec *loads.Document) *WeaviateAPI

NewWeaviateAPI creates a new Weaviate instance

func (*WeaviateAPI) AddMiddlewareFor

func (o *WeaviateAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*WeaviateAPI) AuthenticatorsFor

func (o *WeaviateAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*WeaviateAPI) Authorizer

func (o *WeaviateAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*WeaviateAPI) ConsumersFor

func (o *WeaviateAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*WeaviateAPI) Context

func (o *WeaviateAPI) Context() *middleware.Context

Context returns the middleware context for the weaviate API

func (*WeaviateAPI) DefaultConsumes

func (o *WeaviateAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*WeaviateAPI) DefaultProduces

func (o *WeaviateAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*WeaviateAPI) Formats

func (o *WeaviateAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*WeaviateAPI) HandlerFor

func (o *WeaviateAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*WeaviateAPI) Init

func (o *WeaviateAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*WeaviateAPI) ProducersFor

func (o *WeaviateAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*WeaviateAPI) RegisterConsumer

func (o *WeaviateAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*WeaviateAPI) RegisterFormat

func (o *WeaviateAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*WeaviateAPI) RegisterProducer

func (o *WeaviateAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*WeaviateAPI) Serve

func (o *WeaviateAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*WeaviateAPI) ServeErrorFor

func (o *WeaviateAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*WeaviateAPI) SetDefaultConsumes

func (o *WeaviateAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*WeaviateAPI) SetDefaultProduces

func (o *WeaviateAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*WeaviateAPI) SetSpec

func (o *WeaviateAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*WeaviateAPI) UseRedoc added in v1.18.0

func (o *WeaviateAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*WeaviateAPI) UseSwaggerUI added in v1.18.0

func (o *WeaviateAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*WeaviateAPI) Validate

func (o *WeaviateAPI) Validate() error

Validate validates the registrations in the WeaviateAPI

type WeaviateRoot

type WeaviateRoot struct {
	Context *middleware.Context
	Handler WeaviateRootHandler
}
WeaviateRoot swagger:route GET / weaviateRoot

Home. Discover the REST API

func NewWeaviateRoot

func NewWeaviateRoot(ctx *middleware.Context, handler WeaviateRootHandler) *WeaviateRoot

NewWeaviateRoot creates a new http.Handler for the weaviate root operation

func (*WeaviateRoot) ServeHTTP

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

type WeaviateRootHandler

type WeaviateRootHandler interface {
	Handle(WeaviateRootParams, *models.Principal) middleware.Responder
}

WeaviateRootHandler interface for that can handle valid weaviate root params

type WeaviateRootHandlerFunc

type WeaviateRootHandlerFunc func(WeaviateRootParams, *models.Principal) middleware.Responder

WeaviateRootHandlerFunc turns a function with the right signature into a weaviate root handler

func (WeaviateRootHandlerFunc) Handle

Handle executing the request and returning a response

type WeaviateRootOK

type WeaviateRootOK struct {

	/*
	  In: Body
	*/
	Payload *WeaviateRootOKBody `json:"body,omitempty"`
}

WeaviateRootOK Weaviate is alive and ready to serve content

swagger:response weaviateRootOK

func NewWeaviateRootOK

func NewWeaviateRootOK() *WeaviateRootOK

NewWeaviateRootOK creates WeaviateRootOK with default headers values

func (*WeaviateRootOK) SetPayload

func (o *WeaviateRootOK) SetPayload(payload *WeaviateRootOKBody)

SetPayload sets the payload to the weaviate root o k response

func (*WeaviateRootOK) WithPayload

func (o *WeaviateRootOK) WithPayload(payload *WeaviateRootOKBody) *WeaviateRootOK

WithPayload adds the payload to the weaviate root o k response

func (*WeaviateRootOK) WriteResponse

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

WriteResponse to the client

type WeaviateRootOKBody

type WeaviateRootOKBody struct {

	// links
	Links []*models.Link `json:"links" yaml:"links"`
}

WeaviateRootOKBody weaviate root o k body

swagger:model WeaviateRootOKBody

func (*WeaviateRootOKBody) ContextValidate added in v1.18.0

func (o *WeaviateRootOKBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this weaviate root o k body based on the context it is used

func (*WeaviateRootOKBody) MarshalBinary

func (o *WeaviateRootOKBody) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*WeaviateRootOKBody) UnmarshalBinary

func (o *WeaviateRootOKBody) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*WeaviateRootOKBody) Validate

func (o *WeaviateRootOKBody) Validate(formats strfmt.Registry) error

Validate validates this weaviate root o k body

type WeaviateRootParams

type WeaviateRootParams struct {

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

WeaviateRootParams contains all the bound params for the weaviate root operation typically these are obtained from a http.Request

swagger:parameters weaviate.root

func NewWeaviateRootParams

func NewWeaviateRootParams() WeaviateRootParams

NewWeaviateRootParams creates a new WeaviateRootParams object

There are no default values defined in the spec.

func (*WeaviateRootParams) BindRequest

func (o *WeaviateRootParams) 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 NewWeaviateRootParams() beforehand.

type WeaviateRootURL

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

WeaviateRootURL generates an URL for the weaviate root operation

func (*WeaviateRootURL) Build

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

Build a url path and query string

func (*WeaviateRootURL) BuildFull

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

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

func (*WeaviateRootURL) Must

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

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

func (*WeaviateRootURL) SetBasePath

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

func (o *WeaviateRootURL) String() string

String returns the string representation of the path with query string

func (*WeaviateRootURL) StringFull

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

StringFull returns the string representation of a complete url

func (*WeaviateRootURL) WithBasePath

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

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 WeaviateWellknownLiveness

type WeaviateWellknownLiveness struct {
	Context *middleware.Context
	Handler WeaviateWellknownLivenessHandler
}
WeaviateWellknownLiveness swagger:route GET /.well-known/live weaviateWellknownLiveness

Determines whether the application is alive. Can be used for kubernetes liveness probe

func NewWeaviateWellknownLiveness

func NewWeaviateWellknownLiveness(ctx *middleware.Context, handler WeaviateWellknownLivenessHandler) *WeaviateWellknownLiveness

NewWeaviateWellknownLiveness creates a new http.Handler for the weaviate wellknown liveness operation

func (*WeaviateWellknownLiveness) ServeHTTP

type WeaviateWellknownLivenessHandler

type WeaviateWellknownLivenessHandler interface {
	Handle(WeaviateWellknownLivenessParams, *models.Principal) middleware.Responder
}

WeaviateWellknownLivenessHandler interface for that can handle valid weaviate wellknown liveness params

type WeaviateWellknownLivenessHandlerFunc

type WeaviateWellknownLivenessHandlerFunc func(WeaviateWellknownLivenessParams, *models.Principal) middleware.Responder

WeaviateWellknownLivenessHandlerFunc turns a function with the right signature into a weaviate wellknown liveness handler

func (WeaviateWellknownLivenessHandlerFunc) Handle

Handle executing the request and returning a response

type WeaviateWellknownLivenessOK

type WeaviateWellknownLivenessOK struct {
}

WeaviateWellknownLivenessOK The application is able to respond to HTTP requests

swagger:response weaviateWellknownLivenessOK

func NewWeaviateWellknownLivenessOK

func NewWeaviateWellknownLivenessOK() *WeaviateWellknownLivenessOK

NewWeaviateWellknownLivenessOK creates WeaviateWellknownLivenessOK with default headers values

func (*WeaviateWellknownLivenessOK) WriteResponse

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

WriteResponse to the client

type WeaviateWellknownLivenessParams

type WeaviateWellknownLivenessParams struct {

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

WeaviateWellknownLivenessParams contains all the bound params for the weaviate wellknown liveness operation typically these are obtained from a http.Request

swagger:parameters weaviate.wellknown.liveness

func NewWeaviateWellknownLivenessParams

func NewWeaviateWellknownLivenessParams() WeaviateWellknownLivenessParams

NewWeaviateWellknownLivenessParams creates a new WeaviateWellknownLivenessParams object

There are no default values defined in the spec.

func (*WeaviateWellknownLivenessParams) 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 NewWeaviateWellknownLivenessParams() beforehand.

type WeaviateWellknownLivenessURL

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

WeaviateWellknownLivenessURL generates an URL for the weaviate wellknown liveness operation

func (*WeaviateWellknownLivenessURL) Build

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

Build a url path and query string

func (*WeaviateWellknownLivenessURL) BuildFull

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

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

func (*WeaviateWellknownLivenessURL) Must

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

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

func (*WeaviateWellknownLivenessURL) SetBasePath

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

String returns the string representation of the path with query string

func (*WeaviateWellknownLivenessURL) StringFull

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

StringFull returns the string representation of a complete url

func (*WeaviateWellknownLivenessURL) 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 WeaviateWellknownReadiness

type WeaviateWellknownReadiness struct {
	Context *middleware.Context
	Handler WeaviateWellknownReadinessHandler
}
WeaviateWellknownReadiness swagger:route GET /.well-known/ready weaviateWellknownReadiness

Determines whether the application is ready to receive traffic. Can be used for kubernetes readiness probe.

func NewWeaviateWellknownReadiness

func NewWeaviateWellknownReadiness(ctx *middleware.Context, handler WeaviateWellknownReadinessHandler) *WeaviateWellknownReadiness

NewWeaviateWellknownReadiness creates a new http.Handler for the weaviate wellknown readiness operation

func (*WeaviateWellknownReadiness) ServeHTTP

type WeaviateWellknownReadinessHandler

type WeaviateWellknownReadinessHandler interface {
	Handle(WeaviateWellknownReadinessParams, *models.Principal) middleware.Responder
}

WeaviateWellknownReadinessHandler interface for that can handle valid weaviate wellknown readiness params

type WeaviateWellknownReadinessHandlerFunc

type WeaviateWellknownReadinessHandlerFunc func(WeaviateWellknownReadinessParams, *models.Principal) middleware.Responder

WeaviateWellknownReadinessHandlerFunc turns a function with the right signature into a weaviate wellknown readiness handler

func (WeaviateWellknownReadinessHandlerFunc) Handle

Handle executing the request and returning a response

type WeaviateWellknownReadinessOK

type WeaviateWellknownReadinessOK struct {
}

WeaviateWellknownReadinessOK The application has completed its start-up routine and is ready to accept traffic.

swagger:response weaviateWellknownReadinessOK

func NewWeaviateWellknownReadinessOK

func NewWeaviateWellknownReadinessOK() *WeaviateWellknownReadinessOK

NewWeaviateWellknownReadinessOK creates WeaviateWellknownReadinessOK with default headers values

func (*WeaviateWellknownReadinessOK) WriteResponse

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

WriteResponse to the client

type WeaviateWellknownReadinessParams

type WeaviateWellknownReadinessParams struct {

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

WeaviateWellknownReadinessParams contains all the bound params for the weaviate wellknown readiness operation typically these are obtained from a http.Request

swagger:parameters weaviate.wellknown.readiness

func NewWeaviateWellknownReadinessParams

func NewWeaviateWellknownReadinessParams() WeaviateWellknownReadinessParams

NewWeaviateWellknownReadinessParams creates a new WeaviateWellknownReadinessParams object

There are no default values defined in the spec.

func (*WeaviateWellknownReadinessParams) 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 NewWeaviateWellknownReadinessParams() beforehand.

type WeaviateWellknownReadinessServiceUnavailable

type WeaviateWellknownReadinessServiceUnavailable struct {
}

WeaviateWellknownReadinessServiceUnavailable The application is currently not able to serve traffic. If other horizontal replicas of weaviate are available and they are capable of receiving traffic, all traffic should be redirected there instead.

swagger:response weaviateWellknownReadinessServiceUnavailable

func NewWeaviateWellknownReadinessServiceUnavailable

func NewWeaviateWellknownReadinessServiceUnavailable() *WeaviateWellknownReadinessServiceUnavailable

NewWeaviateWellknownReadinessServiceUnavailable creates WeaviateWellknownReadinessServiceUnavailable with default headers values

func (*WeaviateWellknownReadinessServiceUnavailable) WriteResponse

WriteResponse to the client

type WeaviateWellknownReadinessURL

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

WeaviateWellknownReadinessURL generates an URL for the weaviate wellknown readiness operation

func (*WeaviateWellknownReadinessURL) Build

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

Build a url path and query string

func (*WeaviateWellknownReadinessURL) BuildFull

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

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

func (*WeaviateWellknownReadinessURL) Must

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

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

func (*WeaviateWellknownReadinessURL) SetBasePath

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

String returns the string representation of the path with query string

func (*WeaviateWellknownReadinessURL) StringFull

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

StringFull returns the string representation of a complete url

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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