client

Documentation

Index

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

Variables

var Default = NewHTTPClient(nil)

Default provides an API for the libpod library HTTP client.

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

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

Types

type ProvidesAnAPIForTheLibpodLibrary

type ProvidesAnAPIForTheLibpodLibrary struct {
	Containers containers.ClientService

	ContainersCompat containers_compat.ClientService

	Exec exec.ClientService

	ExecCompat exec_compat.ClientService

	Images images.ClientService

	ImagesCompat images_compat.ClientService

	Manifests manifests.ClientService

	Networks networks.ClientService

	NetworksCompat networks_compat.ClientService

	Pods pods.ClientService

	Secrets secrets.ClientService

	SecretsCompat secrets_compat.ClientService

	System system.ClientService

	SystemCompat system_compat.ClientService

	Volumes volumes.ClientService

	VolumesCompat volumes_compat.ClientService

	Transport runtime.ClientTransport
}

ProvidesAnAPIForTheLibpodLibrary is a client for provides an API for the libpod library

func New

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

New creates a new provides an API for the libpod library client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *ProvidesAnAPIForTheLibpodLibrary

NewHTTPClient creates a new provides an API for the libpod library HTTP client.

func NewHTTPClientWithConfig

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

NewHTTPClientWithConfig creates a new provides an API for the libpod library HTTP client, using a customizable transport config.

func (*ProvidesAnAPIForTheLibpodLibrary) SetTransport

func (c *ProvidesAnAPIForTheLibpodLibrary) 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.