client

Documentation

Index

• Constants
• Variables
• type Portainer
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Portainer
  • func NewHTTPClient(formats strfmt.Registry) *Portainer
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Portainer
  • func (c *Portainer) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *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 = "portainer.domain"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api"
)

Variables

var Default = NewHTTPClient(nil)

Default portainer HTTP client.

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

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

Types

type Portainer

type Portainer struct {
	Auth *auth.Client

	Dockerhub *dockerhub.Client

	EndpointGroups *endpoint_groups.Client

	Endpoints *endpoints.Client

	Registries *registries.Client

	ResourceControls *resource_controls.Client

	Settings *settings.Client

	Stacks *stacks.Client

	Status *status.Client

	Tags *tags.Client

	TeamMemberships *team_memberships.Client

	Teams *teams.Client

	Templates *templates.Client

	Upload *upload.Client

	Users *users.Client

	Transport runtime.ClientTransport
}

Portainer is a client for portainer

func New

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

New creates a new portainer client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Portainer

NewHTTPClient creates a new portainer HTTP client.

func NewHTTPClientWithConfig

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

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

func (*Portainer) SetTransport

func (c *Portainer) 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
}

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) 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.