rest

Documentation

Overview

Package rest has generic implementations of resources used for REST responses

Index

• type LocationStreamer
  • func (s *LocationStreamer) InputStream(apiVersion, acceptHeader string) (stream io.ReadCloser, flush bool, contentType string, err error)
  • func (*LocationStreamer) IsAnAPIObject()
• type UpgradeAwareProxyHandler
  • func NewUpgradeAwareProxyHandler(location *url.URL, transport http.RoundTripper, ...) *UpgradeAwareProxyHandler
  • func (h *UpgradeAwareProxyHandler) RequestError() error
  • func (h *UpgradeAwareProxyHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

Types

type LocationStreamer

type LocationStreamer struct {
	Location    *url.URL
	Transport   http.RoundTripper
	ContentType string
	Flush       bool
}

LocationStreamer is a resource that streams the contents of a particular location URL

func (*LocationStreamer) InputStream

func (s *LocationStreamer) InputStream(apiVersion, acceptHeader string) (stream io.ReadCloser, flush bool, contentType string, err error)

InputStream returns a stream with the contents of the URL location. If no location is provided, a null stream is returned.

func (*LocationStreamer) IsAnAPIObject

func (*LocationStreamer) IsAnAPIObject()

IsAnAPIObject marks this object as a runtime.Object

type UpgradeAwareProxyHandler

type UpgradeAwareProxyHandler struct {
	UpgradeRequired bool
	Location        *url.URL
	// Transport provides an optional round tripper to use to proxy. If nil, the default proxy transport is used
	Transport http.RoundTripper
	// WrapTransport indicates whether the provided Transport should be wrapped with default proxy transport behavior (URL rewriting, X-Forwarded-* header setting)
	WrapTransport  bool
	FlushInterval  time.Duration
	MaxBytesPerSec int64
	// contains filtered or unexported fields
}

UpgradeAwareProxyHandler is a handler for proxy requests that may require an upgrade

func NewUpgradeAwareProxyHandler

func NewUpgradeAwareProxyHandler(location *url.URL, transport http.RoundTripper, wrapTransport, upgradeRequired bool) *UpgradeAwareProxyHandler

NewUpgradeAwareProxyHandler creates a new proxy handler with a default flush interval

func (*UpgradeAwareProxyHandler) RequestError

func (h *UpgradeAwareProxyHandler) RequestError() error

RequestError returns an error that occurred while handling request

func (*UpgradeAwareProxyHandler) ServeHTTP

func (h *UpgradeAwareProxyHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP handles the proxy request