core

Documentation

Index

• type APIError
  • func NewAPIError(statusCode int, header http.Header, err error) *APIError
  • func (a *APIError) Error() string
  • func (a *APIError) Unwrap() error
• type APIKeyOption
• type BaseURLOption
• type BodyPropertiesOption
• type HTTPClient
• type HTTPClientOption
• type HTTPHeaderOption
• type MaxAttemptsOption
• type MaxBufSizeOption
• type MaxStreamReconnectAttemptsOption
• type QueryParametersOption
• type RequestOption
• type RequestOptions
  • func NewRequestOptions(opts ...RequestOption) *RequestOptions
  • func (r *RequestOptions) ToHeader() http.Header
• type Response
• type WithoutRetriesOption
• type WithoutStreamReconnectionOption

Types

type APIError

type APIError struct {
	StatusCode int         `json:"-"`
	Header     http.Header `json:"-"`
	// contains filtered or unexported fields
}

APIError is a lightweight wrapper around the standard error interface that preserves the status code from the RPC, if any.

func NewAPIError

func NewAPIError(statusCode int, header http.Header, err error) *APIError

NewAPIError constructs a new API error.

func (*APIError) Error

func (a *APIError) Error() string

Error returns the API error's message.

func (*APIError) Unwrap

func (a *APIError) Unwrap() error

Unwrap returns the underlying error. This also makes the error compatible with errors.As and errors.Is.

type APIKeyOption

type APIKeyOption struct {
	APIKey string
}

APIKeyOption implements the RequestOption interface.

type BaseURLOption

type BaseURLOption struct {
	BaseURL string
}

BaseURLOption implements the RequestOption interface.

type BodyPropertiesOption

type BodyPropertiesOption struct {
	BodyProperties map[string]interface{}
}

BodyPropertiesOption implements the RequestOption interface.

type HTTPClient

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

HTTPClient is an interface for a subset of the *http.Client.

type HTTPClientOption

type HTTPClientOption struct {
	HTTPClient HTTPClient
}

HTTPClientOption implements the RequestOption interface.

type HTTPHeaderOption

type HTTPHeaderOption struct {
	HTTPHeader http.Header
}

HTTPHeaderOption implements the RequestOption interface.

type MaxAttemptsOption

type MaxAttemptsOption struct {
	MaxAttempts uint
}

MaxAttemptsOption implements the RequestOption interface.

type MaxBufSizeOption

type MaxBufSizeOption struct {
	MaxBufSize int
}

MaxBufSizeOption implements the RequestOption interface.

type MaxStreamReconnectAttemptsOption

type MaxStreamReconnectAttemptsOption struct {
	MaxStreamReconnectAttempts uint
}

MaxStreamReconnectAttemptsOption implements the RequestOption interface.

type QueryParametersOption

type QueryParametersOption struct {
	QueryParameters url.Values
}

QueryParametersOption implements the RequestOption interface.

type RequestOption

type RequestOption interface {
	// contains filtered or unexported methods
}

RequestOption adapts the behavior of the client or an individual request.

type RequestOptions

type RequestOptions struct {
	BaseURL                    string
	HTTPClient                 HTTPClient
	HTTPHeader                 http.Header
	BodyProperties             map[string]interface{}
	QueryParameters            url.Values
	MaxAttempts                uint
	MaxBufSize                 int
	MaxStreamReconnectAttempts uint
	DisableStreamReconnection  bool
	DisableRetries             bool
	APIKey                     string
}

RequestOptions defines all of the possible request options.

This type is primarily used by the generated code and is not meant to be used directly; use the option package instead.

func NewRequestOptions

func NewRequestOptions(opts ...RequestOption) *RequestOptions

NewRequestOptions returns a new *RequestOptions value.

This function is primarily used by the generated code and is not meant to be used directly; use RequestOption instead.

func (*RequestOptions) ToHeader

func (r *RequestOptions) ToHeader() http.Header

ToHeader maps the configured request options into a http.Header used for the request(s).

type Response

type Response[T any] struct {
	StatusCode int
	Header     http.Header
	Body       T
}

Response is an HTTP response from an HTTP client.

type WithoutRetriesOption

type WithoutRetriesOption struct{}

WithoutRetriesOption implements the RequestOption interface.

type WithoutStreamReconnectionOption

type WithoutStreamReconnectionOption struct{}

WithoutStreamReconnectionOption implements the RequestOption interface.