router

Documentation

Index

• type API
  • func NewAPIRouter(protocol, fqdn string) (API, error)
  • func NewRelativeAPIRouter() (API, error)
• type Web
  • func NewRelativeWebRouter() (Web, error)
  • func NewWebRouter(protocol, fqdn string) (Web, error)

Types

type API

type API interface {
	UpdateWorkspaceStatus(namespace, uid string) string
}

API provides methods to generate urls for the API

func NewAPIRouter

func NewAPIRouter(protocol, fqdn string) (API, error)

NewAPIRouter creates a new api router used to generate urls for the api

func NewRelativeAPIRouter

func NewRelativeAPIRouter() (API, error)

NewRelativeAPIRouter creates an api router that does relative routes, with no protocol or fqdn

type Web

type Web interface {
	WorkflowExecution(namespace, uid string) string
}

Web provides methods to generate urls for the web client this can be used to generate urls for workspaces or workflows when they are ready.

func NewRelativeWebRouter

func NewRelativeWebRouter() (Web, error)

NewRelativeWebRouter creates a web router that does relative routes, with no protocol or fqdn

func NewWebRouter

func NewWebRouter(protocol, fqdn string) (Web, error)

NewWebRouter creates a new web router used to generate urls for the web client