common

Documentation

Index

• Constants
• func DefineAPIClient(serverURL string, transport *http.Client, userAgent *string, debug bool) (*api.APIClient, error)
• func FetchUserProvidedRequestID(ctxt context.Context) *string
• func GetUnitTestHttpmqDataAPIURL() string
• func GetUnitTestHttpmqMgmtAPIURL() string
• type HttpmqAPIError
  • func GenerateHttpmqError(reqID string, statusCode int, err *api.GoutilsErrorDetail) HttpmqAPIError
  • func (e HttpmqAPIError) Error() string
• type UseGivenRequestID

Constants

const RequestIDHeader = "Httpmq-Request-ID"

RequestIDHeader is expected HTTP header field carrying the httpmq request ID

Functions

func DefineAPIClient

func DefineAPIClient(
	serverURL string, transport *http.Client, userAgent *string, debug bool,
) (*api.APIClient, error)

DefineAPIClient create an API client object targeting a specific httpmq server URL

@param serverUrl string - httpmq server URL
@param transport *http.Client - HTTP client used by the API
@param userAgent *string - user agent to use if not nil
@param debug bool - whether to enable API debug logging
@return client object

func FetchUserProvidedRequestID

func FetchUserProvidedRequestID(ctxt context.Context) *string

FetchUserProvidedRequestID reads the user provided request ID from context if present

@param ctxt context.Context - the request context
@return if present, the user provided request ID
        or nil

func GetUnitTestHttpmqDataAPIURL

func GetUnitTestHttpmqDataAPIURL() string

GetUnitTestHttpmqDataAPIURL is a helper function to build the httpmq dataplane API URL for testing

@return the httpmq dataplane API URL

func GetUnitTestHttpmqMgmtAPIURL

func GetUnitTestHttpmqMgmtAPIURL() string

GetUnitTestHttpmqMgmtAPIURL is a helper function to build the httpmq management API URL for testing

@return the httpmq management API URL

Types

type HttpmqAPIError

type HttpmqAPIError struct {
	// RequestID is the request ID to match against logs
	RequestID string
	// StatusCode is the response code returned by httpmq
	StatusCode int
	// Message is an optional descriptive message
	Message *string
	// Detail is an optional descriptive message providing additional details on the error
	Detail *string
}

HttpmqAPIError is the custom error returned by httpmq

func GenerateHttpmqError

func GenerateHttpmqError(reqID string, statusCode int, err *api.GoutilsErrorDetail) HttpmqAPIError

GenerateHttpmqError generate a HttpmqAPIError object from the error response from httpmq

@param reqID string - the request ID
@param err *api.ApisErrorDetail - the error message
@return a HttpmqAPIError instance

func (HttpmqAPIError) Error

func (e HttpmqAPIError) Error() string

Error implements the error interface for HttpmqAPIError

type UseGivenRequestID

type UseGivenRequestID struct{}

UseGivenRequestID is the Key type for adding a user provided request ID to a request context