client

Documentation

Index

• Constants
• type Auth
  • func (t *Auth) CalculateExpiry(willExpire int64)
  • func (au *Auth) IsValid() bool
• type Client
  • func GetClient(clientUrl, username, password, proxyUrl, proxyCreds, loginDomain string, ...) *Client
  • func (c *Client) Authenticate() error
  • func (c *Client) Do(req *http.Request, skipLoggingPayload bool) (*gabs.Container, *http.Response, error)
  • func (c *Client) DoRestRequest(ctx context.Context, diags *diag.Diagnostics, path, method string, ...) *gabs.Container
  • func (client *Client) InjectAuthenticationHeader(req *http.Request, path string) (*http.Request, error)
  • func (c *Client) MakeRestRequest(method string, path string, body *gabs.Container, authenticated bool, ...) (*http.Request, error)

Constants

const DefaultBackoffDelayFactor float64 = 3

const DefaultBackoffMaxDelay int = 60

const DefaultBackoffMinDelay int = 4

const DefaultReqTimeoutVal int = 100

Default timeout for NGINX in ND is 90 Seconds. Allow the client to set a shorter or longer time depending on their environment

Types

type Auth

type Auth struct {
	Token  string
	Expiry time.Time
}

func (*Auth) CalculateExpiry

func (t *Auth) CalculateExpiry(willExpire int64)

func (*Auth) IsValid

func (au *Auth) IsValid() bool

type Client

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

Client is the main entry point

func GetClient

func GetClient(clientUrl, username, password, proxyUrl, proxyCreds, loginDomain string, isInsecure bool, maxRetries int64) *Client

GetClient returns a singleton

func (*Client) Authenticate

func (c *Client) Authenticate() error

func (*Client) Do

func (c *Client) Do(req *http.Request, skipLoggingPayload bool) (*gabs.Container, *http.Response, error)

func (*Client) DoRestRequest

func (c *Client) DoRestRequest(ctx context.Context, diags *diag.Diagnostics, path, method string, payload *gabs.Container) *gabs.Container

func (c *Client) DoRestRequest(ctx context.Context, diags *diag.Diagnostics, client *Client, path, method string, payload *gabs.Container) *gabs.Container {

func (*Client) InjectAuthenticationHeader

func (client *Client) InjectAuthenticationHeader(req *http.Request, path string) (*http.Request, error)

func (*Client) MakeRestRequest

func (c *Client) MakeRestRequest(method string, path string, body *gabs.Container, authenticated bool, skipLoggingPayload bool) (*http.Request, error)