api

Jan 23, 2024

Changes in this version

type Client

+ GetCustomHTTPHeaders func() http.Header

+ type ContextKey string

+ type TimeoutSemaphore struct

+ Logger Logger

+ Semaphore chan struct{}

+ Timeout time.Duration

+ func (ts *TimeoutSemaphore) Acquire(ctx context.Context) error

+ func (ts *TimeoutSemaphore) Release(ctx context.Context)

+ func (ts *TimeoutSemaphore) SetLogger(logger Logger) TimeoutSemaphoreInterface

Jun 3, 2022

Changes in this version

type ApiClient

+ GetCustomHTTPHeaders func() http.Header

type ClientIMPL

+ func (c *ClientIMPL) GetCustomHTTPHeaders() http.Header

Sep 20, 2021

Changes in this version

+ const UnableToFailoverFromDestination

+ const UnknownVolumeGroupErrorCode

Mar 16, 2021

Changes in this version

+ const UnableToMatchHostVolume

+ func NewTimeoutSemaphore(timeout, rateLimit int, logger Logger) *timeoutSemaphore

+ type ApiClient interface

+ Query func(ctx context.Context, cfg RequestConfigRenderer, resp interface{}) (RespMeta, error)

+ QueryParams func() QueryParamsEncoder

+ QueryParamsWithFields func(provider FieldProvider) QueryParamsEncoder

+ SetCustomHTTPHeaders func(headers http.Header)

+ SetLogger func(logger Logger)

+ type TimeoutSemaphoreError struct

+ func (e *TimeoutSemaphoreError) Error() string

+ type TimeoutSemaphoreInterface interface

+ Acquire func(ctx context.Context) error

+ Release func(ctx context.Context)

+ SetLogger func(logger Logger) TimeoutSemaphoreInterface

Dec 14, 2020

Changes in this version

+ const VolumeIsNotAttachedToHost

Sep 21, 2020

Changes in this version

+ const FilesystemNameAlreadyUseErrorCode

+ const HostAlreadyPresentInNFSExport

+ const HostAlreadyRemovedFromNFSExport

May 6, 2020

Changes in this version

+ const BadRangeCode

+ const HostIsNotAttachedToVolumeErrorCode

+ const InstanceWasNotFound

+ const InvalidInstance

+ const NoHostObjectFoundCode

+ const SnapshotNameAlreadyUseErrorCode

+ const UnknownVolumeErrorCode

+ const VolumeAttachedToHost

+ const VolumeNameAlreadyUseErrorCode

+ type Client interface

+ Query func(ctx context.Context, cfg RequestConfigRenderer, resp interface{}) (RespMeta, error)

+ QueryParams func() QueryParamsEncoder

+ QueryParamsWithFields func(provider FieldProvider) QueryParamsEncoder

+ SetCustomHTTPHeaders func(headers http.Header)

+ SetLogger func(logger Logger)

+ type ClientIMPL struct

+ func New(apiURL string, username string, password string, insecure bool, ...) (*ClientIMPL, error)

+ func (c *ClientIMPL) Query(ctx context.Context, cfg RequestConfigRenderer, resp interface{}) (RespMeta, error)

+ func (c *ClientIMPL) QueryParams() QueryParamsEncoder

+ func (c *ClientIMPL) QueryParamsWithFields(fp FieldProvider) QueryParamsEncoder

+ func (c *ClientIMPL) SetCustomHTTPHeaders(headers http.Header)

+ func (c *ClientIMPL) SetLogger(logger Logger)

+ func (c *ClientIMPL) SetTraceID(ctx context.Context, traceID string) context.Context

+ func (c *ClientIMPL) TraceID(ctx context.Context) string

+ type ErrorMsg struct

+ Arguments []string

+ ErrorCode string

+ Message string

+ Severity string

+ StatusCode int

+ func (err *ErrorMsg) Error() string

+ type FieldProvider interface

+ Fields func() []string

+ type Logger interface

+ Debug func(ctx context.Context, format string, args ...interface{})

+ Error func(ctx context.Context, format string, args ...interface{})

+ Info func(ctx context.Context, format string, args ...interface{})

+ type PaginationInfo struct

+ First int

+ IsPaginate bool

+ Last int

+ Total int

+ type QueryParams struct

+ func (qp *QueryParams) Async(value bool) QueryParamsEncoder

+ func (qp *QueryParams) Encode() string

+ func (qp *QueryParams) Limit(value int) QueryParamsEncoder

+ func (qp *QueryParams) Offset(value int) QueryParamsEncoder

+ func (qp *QueryParams) Order(fields ...string) QueryParamsEncoder

+ func (qp *QueryParams) RawArg(key string, value string) QueryParamsEncoder

+ func (qp *QueryParams) Select(fields ...string) QueryParamsEncoder

+ type QueryParamsEncoder interface

+ Async func(bool) QueryParamsEncoder

+ Encode func() string

+ Limit func(int) QueryParamsEncoder

+ Offset func(int) QueryParamsEncoder

+ Order func(...string) QueryParamsEncoder

+ RawArg func(string, string) QueryParamsEncoder

+ Select func(...string) QueryParamsEncoder

+ type RequestConfig struct

+ Action string

+ Body interface{}

+ Endpoint string

+ ID string

+ Method string

+ QueryParams QueryParamsEncoder

+ func (rc RequestConfig) RenderRequestConfig() RequestConfig

+ type RequestConfigRenderer interface

+ RenderRequestConfig func() RequestConfig

+ type RespMeta struct

+ Pagination PaginationInfo

+ Status int

+ type Traceable interface

+ SetTraceID func(ctx context.Context, traceID string) context.Context

+ TraceID func(ctx context.Context) string