clients

Documentation

Index

• Constants
• type Client
  • func NewHttpRequest(spec *receivers.Spec, parameters map[string]string, envVars map[string]string, ...) (Client, error)
• type ClientImpl
• type Response
  • func (r *Response) IsOK() bool

Constants

const (
	GetMethod         = "GET"
	MaxRequestTimeout = 5 * time.Second
)

Types

type Client

type Client interface {
	//
	// SendRequest dispatches a receivedRequest based on the integration spec.
	//
	SendRequest() (*Response, error)

	//
	// SetClient change the internal http client.
	//
	SetClient(client ClientImpl)
}

func NewHttpRequest

func NewHttpRequest(
	spec *receivers.Spec,
	parameters map[string]string,
	envVars map[string]string,
	logger *log.Logger,
) (Client, error)

SendHttpRequest creates a *httpClient* with all required parameters to make a successful receivedRequest.

type ClientImpl

type ClientImpl interface {
	Do(req *http.Request) (*http.Response, error)
}

ClientImpl provides an interface for a specific implementation.

Added for convenience to create a mock implementation.

type Response

type Response struct {
	Code int
	Body string
	// contains filtered or unexported fields
}

Response represents the http code and body content.

func (*Response) IsOK

func (r *Response) IsOK() bool

IsOk returns true if status code matches one of the validCodes