client

Documentation

Index

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

Variables

var Default = NewHTTPClient(nil)

Default rest HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

type Rest

type Rest struct {
	Accounts accounts.ClientService

	Authentication authentication.ClientService

	BillingCostsAnalysis billing_costs_analysis.ClientService

	Comments comments.ClientService

	DeploymentTemplates deployment_templates.ClientService

	Deployments deployments.ClientService

	DeploymentsNotes deployments_notes.ClientService

	DeploymentsTrafficFilter deployments_traffic_filter.ClientService

	Extensions extensions.ClientService

	Organizations organizations.ClientService

	Platform platform.ClientService

	PlatformConfigurationInstances platform_configuration_instances.ClientService

	PlatformConfigurationNetworking platform_configuration_networking.ClientService

	PlatformConfigurationSecurity platform_configuration_security.ClientService

	PlatformConfigurationSnapshots platform_configuration_snapshots.ClientService

	PlatformConfigurationTemplates platform_configuration_templates.ClientService

	PlatformConfigurationTrustRelationships platform_configuration_trust_relationships.ClientService

	PlatformInfrastructure platform_infrastructure.ClientService

	Stack stack.ClientService

	Telemetry telemetry.ClientService

	Users users.ClientService

	Transport runtime.ClientTransport
}

Rest is a client for rest

func New

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

New creates a new rest client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Rest

NewHTTPClient creates a new rest HTTP client.

func NewHTTPClientWithConfig

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

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

func (*Rest) SetTransport

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