client

Documentation

Index

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

Variables

var Default = NewHTTPClient(nil)

Default k m s internal API HTTP client.

var DefaultSchemes = []string{"http"}

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

Types

type Config

type Config struct {
	Host     string   `yaml:"host" env:"KMS_CLIENT_HOST" env-default:"localhost:14000" env-description:"KMS server host. Example: localhost:14000"`
	BasePath string   `yaml:"base_path" env:"KMS_CLIENT_BASE_PATH" env-default:"/api/kms/v1" env-description:"Internal variable"`
	Schemes  []string `yaml:"schemes" env:"KMS_CLIENT_SCHEMES" env-default:"http" env-description:"Internal variable"`
}

type KMSInternalAPI

type KMSInternalAPI struct {
	Wallet wallet.ClientService

	Transport runtime.ClientTransport
}

KMSInternalAPI is a client for k m s internal API

func New

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

New creates a new k m s internal API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *KMSInternalAPI

NewHTTPClient creates a new k m s internal API HTTP client.

func NewHTTPClientWithConfig

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

NewHTTPClientWithConfig creates a new k m s internal API HTTP client, using a customizable transport config.

func (*KMSInternalAPI) SetTransport

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