misc

Documentation

Index

• type API
  • func New(con *connection.Connection, dbVersionProvider *db.VersionProvider) *API
  • func (misc *API) LiveChecker() *LiveChecker
  • func (misc *API) MetaGetter() *MetaGetter
  • func (misc *API) OpenIDConfigurationGetter() *OpenIDConfigGetter
  • func (misc *API) ReadyChecker() *ReadyChecker
• type LiveChecker
  • func (lc *LiveChecker) Do(ctx context.Context) (bool, error)
• type MetaGetter
  • func (mg *MetaGetter) Do(ctx context.Context) (*models.Meta, error)
• type OpenIDConfigGetter
  • func (oidcg *OpenIDConfigGetter) Do(ctx context.Context) (*OpenIDConfiguration, error)
• type OpenIDConfiguration
• type ReadyChecker
  • func (rc *ReadyChecker) Do(ctx context.Context) (bool, error)

Types

type API

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

API collection of endpoints that don't fit in other categories

func New

func New(con *connection.Connection, dbVersionProvider *db.VersionProvider) *API

New Misc (meta, .well-known) api group from connection

func (*API) LiveChecker

func (misc *API) LiveChecker() *LiveChecker

LiveChecker retrieves weaviate live status

func (*API) MetaGetter

func (misc *API) MetaGetter() *MetaGetter

MetaGetter returns a builder to get the weaviate meta description

func (*API) OpenIDConfigurationGetter

func (misc *API) OpenIDConfigurationGetter() *OpenIDConfigGetter

OpenIDConfigurationGetter retrieves the Open ID configuration may be nil

func (*API) ReadyChecker

func (misc *API) ReadyChecker() *ReadyChecker

ReadyChecker retrieves weaviate ready status

type LiveChecker

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

LiveChecker builder to check if weaviate is live

func (*LiveChecker) Do

func (lc *LiveChecker) Do(ctx context.Context) (bool, error)

Do the LiveChecker request

type MetaGetter

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

MetaGetter builder to get meta endpoint

func (*MetaGetter) Do

func (mg *MetaGetter) Do(ctx context.Context) (*models.Meta, error)

Do get the meta endpoint

type OpenIDConfigGetter

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

OpenIDConfigGetter builder to retrieve the openID configuration

func (*OpenIDConfigGetter) Do

func (oidcg *OpenIDConfigGetter) Do(ctx context.Context) (*OpenIDConfiguration, error)

Do the open ID config request

type OpenIDConfiguration

type OpenIDConfiguration struct {
	// The Location to redirect to
	Href string `json:"href,omitempty"`
	// OAuth Client ID
	ClientID string `json:"clientId,omitempty"`
}

OpenIDConfiguration of weaviate

type ReadyChecker

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

ReadyChecker builder to check if weaviate is ready

func (*ReadyChecker) Do

func (rc *ReadyChecker) Do(ctx context.Context) (bool, error)

Do the ready request