rest_client

Documentation

Index

• Constants
• Variables
• 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
• type ZitiEdge
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *ZitiEdge
  • func NewHTTPClient(formats strfmt.Registry) *ZitiEdge
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *ZitiEdge
  • func (c *ZitiEdge) SetTransport(transport runtime.ClientTransport)

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "demo.ziti.dev"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/edge/v1"
)

Variables

var Default = NewHTTPClient(nil)

Default ziti edge HTTP client.

var DefaultSchemes = []string{"https"}

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

Types

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.

type ZitiEdge

type ZitiEdge struct {
	APISession api_session.ClientService

	Authentication authentication.ClientService

	Authenticator authenticator.ClientService

	CertificateAuthority certificate_authority.ClientService

	Config config.ClientService

	CurrentAPISession current_api_session.ClientService

	Database database.ClientService

	EdgeRouter edge_router.ClientService

	EdgeRouterPolicy edge_router_policy.ClientService

	Enroll enroll.ClientService

	Enrollment enrollment.ClientService

	GeoRegion geo_region.ClientService

	Identity identity.ClientService

	Informational informational.ClientService

	RoleAttributes role_attributes.ClientService

	Service service.ClientService

	ServiceEdgeRouterPolicy service_edge_router_policy.ClientService

	ServicePolicy service_policy.ClientService

	Session session.ClientService

	Terminator terminator.ClientService

	TransitRouter transit_router.ClientService

	WellKnown well_known.ClientService

	Transport runtime.ClientTransport
}

ZitiEdge is a client for ziti edge

func New

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

New creates a new ziti edge client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *ZitiEdge

NewHTTPClient creates a new ziti edge HTTP client.

func NewHTTPClientWithConfig

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

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

func (*ZitiEdge) SetTransport

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

SetTransport changes the transport on the client and all its subresources