client

Documentation

Index

• Constants
• Variables
• type Flow
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Flow
  • func NewHTTPClient(formats strfmt.Registry) *Flow
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Flow
  • func (c *Flow) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHTTPClient(client *http.Client) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "localhost"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default flow HTTP client.

var DefaultSchemes = []string{"http", "https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type Flow

type Flow struct {
	FlowService *flow_service.Client

	Transport runtime.ClientTransport
}

Flow is a client for flow

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Flow

New creates a new flow client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Flow

NewHTTPClient creates a new flow HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Flow

NewHTTPClientWithConfig creates a new flow HTTP client, using a customizable transport config.

func (*Flow) SetTransport

func (c *Flow) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host       string
	BasePath   string
	Schemes    []string
	HTTPClient *http.Client
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHTTPClient

func (cfg *TransportConfig) WithHTTPClient(client *http.Client) *TransportConfig

WithHTTPClient overrides the default HTTP client

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.