client

package

v0.0.0-...-632707f Latest Latest Go to latest Published: Oct 19, 2020 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/xabinapal/gopve

Documentation ¶

Index ¶

Constants
type API
- func NewAPI(cli client.Client, poolingInterval time.Duration) API
type Client
- func NewClient(cfg Config) (*Client, error)
- func NewClientWithExecutor(exc request.Executor, poolingInterval time.Duration) *Client
type Config
- func (cfg Config) Endpoint() (*url.URL, error)
type ConfigError
- func (e ConfigError) Error() string

Constants ¶

View Source

const (
	DefaultRequestTimeout  = time.Duration(30) * time.Second
	DefaultPoolingInterval = time.Duration(5) * time.Second
)

View Source

const (
	ErrConfigNoHost = ConfigError("no host specified")
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API client.API

func NewAPI ¶

func NewAPI(cli client.Client, poolingInterval time.Duration) API

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(cfg Config) (*Client, error)

func NewClientWithExecutor ¶

func NewClientWithExecutor(
	exc request.Executor,
	poolingInterval time.Duration,
) *Client

func (*Client) API ¶

func (cli *Client) API() API

func (*Client) AuthenticateWithCredentials ¶

func (cli *Client) AuthenticateWithCredentials(
	username, password string,
) error

func (*Client) AuthenticateWithToken ¶

func (cli *Client) AuthenticateWithToken(id, secret string) error

func (*Client) EndAtomicBlock ¶

func (cli *Client) EndAtomicBlock()

func (*Client) Request ¶

func (cli *Client) Request(
	method, resource string,
	form request.Values,
	out interface{},
) error

func (*Client) StartAtomicBlock ¶

func (cli *Client) StartAtomicBlock()

func (*Client) Version ¶

func (cli *Client) Version() (*types.Version, error)

type Config ¶

type Config struct {
	Host   string
	Port   uint16
	Path   string
	Secure bool

	HTTPTransport   *http.Transport
	RequestTimeout  time.Duration
	PoolingInterval time.Duration
}

func (Config) Endpoint ¶

func (cfg Config) Endpoint() (*url.URL, error)

type ConfigError ¶

type ConfigError string

func (ConfigError) Error ¶

func (e ConfigError) Error() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
test

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL