http

Documentation

Index

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

Variables

var Default = NewHTTPClient(nil)

Default singularity API HTTP client.

var DefaultSchemes = []string{"http"}

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

Types

type SingularityAPI

type SingularityAPI struct {
	Admin admin.ClientService

	Deal deal.ClientService

	DealSchedule deal_schedule.ClientService

	File file.ClientService

	Job job.ClientService

	Piece piece.ClientService

	Preparation preparation.ClientService

	Storage storage.ClientService

	Wallet wallet.ClientService

	WalletAssociation wallet_association.ClientService

	Transport runtime.ClientTransport
}

SingularityAPI is a client for singularity API

func New

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

New creates a new singularity API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *SingularityAPI

NewHTTPClient creates a new singularity API HTTP client.

func NewHTTPClientWithConfig

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

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

func (*SingularityAPI) SetTransport

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