Documentation
¶
Index ¶
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 = "/api" )
Variables ¶
var Default = NewHTTPClient(nil)
Default portainer client API HTTP client.
var DefaultSchemes = []string{"http", "https"}
DefaultSchemes are the default schemes found in Meta (info) section of spec file
Functions ¶
This section is empty.
Types ¶
type PortainerClientAPI ¶
type PortainerClientAPI struct {
Auth auth.ClientService
Backup backup.ClientService
Chat chat.ClientService
CloudCredentials cloud_credentials.ClientService
CustomTemplates custom_templates.ClientService
Docker docker.ClientService
Edge edge.ClientService
EdgeConfigs edge_configs.ClientService
EdgeGroups edge_groups.ClientService
EdgeJobs edge_jobs.ClientService
EdgeStacks edge_stacks.ClientService
EdgeUpdateSchedules edge_update_schedules.ClientService
EndpointGroups endpoint_groups.ClientService
Endpoints endpoints.ClientService
Gitops gitops.ClientService
Helm helm.ClientService
Intel intel.ClientService
Kaas kaas.ClientService
Kubernetes kubernetes.ClientService
Ldap ldap.ClientService
License license.ClientService
Motd motd.ClientService
Registries registries.ClientService
ResourceControls resource_controls.ClientService
Roles roles.ClientService
Settings settings.ClientService
Ssl ssl.ClientService
Stacks stacks.ClientService
Status status.ClientService
Support support.ClientService
System system.ClientService
Tags tags.ClientService
TeamMemberships team_memberships.ClientService
Teams teams.ClientService
Templates templates.ClientService
Upload upload.ClientService
Useractivity useractivity.ClientService
Users users.ClientService
Webhooks webhooks.ClientService
Websocket websocket.ClientService
Transport runtime.ClientTransport
}
PortainerClientAPI is a client for portainer client API
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) *PortainerClientAPI
New creates a new portainer client API client
func NewHTTPClient ¶
func NewHTTPClient(formats strfmt.Registry) *PortainerClientAPI
NewHTTPClient creates a new portainer client API HTTP client.
func NewHTTPClientWithConfig ¶
func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *PortainerClientAPI
NewHTTPClientWithConfig creates a new portainer client API HTTP client, using a customizable transport config.
func (*PortainerClientAPI) SetTransport ¶
func (c *PortainerClientAPI) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client and all its subresources
type TransportConfig ¶
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.
Source Files
Directories