api

package

Go to main page

Versions in this module

v0

v0.9.1

Feb 27, 2023

v0.9.0

Feb 15, 2023

Changes in this version

type Client

+ func (c *Client) SetRoundTripper(rt http.RoundTripper)

type ClientInterface

+ SetRoundTripper func(rt http.RoundTripper)

+ type RateRoundTripper struct

+ Limiter *rate.Limiter

+ RroundTripper http.RoundTripper

+ func NewRateRoundTripper(rt http.RoundTripper, limiter *rate.Limiter) *RateRoundTripper

+ func (r *RateRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

v0.8.0

Feb 12, 2023

Changes in this version

+ var JSON = NewJSONAPIAdapter()

type AsyncResponse

+ JobsURL string

+ type JSONAPIAdapter struct

+ Apply jsoniter.API

+ Create jsoniter.API

+ JSON jsoniter.API

+ Read jsoniter.API

+ Update jsoniter.API

+ func NewJSONAPIAdapter() *JSONAPIAdapter

+ func (j *JSONAPIAdapter) MarshalApply(body interface{}) ([]byte, error)

+ func (j *JSONAPIAdapter) MarshalCreate(body interface{}) ([]byte, error)

+ func (j *JSONAPIAdapter) MarshalOutput(spec Spec) ([]byte, error)

+ func (j *JSONAPIAdapter) MarshalUpdate(body interface{}) ([]byte, error)

+ func (j *JSONAPIAdapter) UnMarshalInput(bs []byte, obj Object) error

+ func (j *JSONAPIAdapter) UnmarshalRead(bs []byte, o interface{}) error

+ type JSONAPIInterface interface

+ MarshalApply func(body interface{}) ([]byte, error)

+ MarshalCreate func(body interface{}) ([]byte, error)

+ MarshalUpdate func(body interface{}) ([]byte, error)

+ UnmarshalRead func(bs []byte, o interface{}) error

+ type JSONFileInterface interface

+ MarshalOutput func(spec Spec) ([]byte, error)

+ UnMarshalInput func(bs []byte, obj Object) error

+ type KeywordsLabels []Label

+ func (c KeywordsLabels) EncodeValues(key string, v *url.Values) error

+ type Label struct

+ Key string

+ Value string

+ func (l Label) String() string

type RequestInfo

+ URL string

v0.7.1

May 18, 2022

v0.7.0

May 18, 2022

v0.6.2

Apr 13, 2022

v0.6.1

Mar 27, 2022

Changes in this version

+ type KeywordsID []int64

+ func (s KeywordsID) Validate() bool

v0.6.0

Mar 26, 2022

Changes in this version

type Client

+ Json JsonApiInterface

type CountableListSpec

+ func DeepCopyCountableListSpec(s CountableListSpec) CountableListSpec

+ type JsonFileInterface interface

+ MarshalOutput func(spec Spec) ([]byte, error)

+ UnMarshalInput func(bs []byte, obj Object) error

type ListSpec

+ func DeepCopyListSpec(s ListSpec) ListSpec

type OutputFrame

+ Resource Object

type ResponseCommon

+ RequestID string

type Spec

+ func DeepCopySpec(s Spec) Spec

v0.5.0

Aug 17, 2021

Changes in this version

type Client

+ func (c *Client) ListAll(s CountableListSpec, keywords SearchParams) (requestId string, err error)

type ClientInterface

+ ListAll func(s CountableListSpec, keywords SearchParams) (requestId string, err error)

+ type JsonAPIAdapter struct

+ func (j *JsonAPIAdapter) MarshalApply(body interface{}) ([]byte, error)

+ func (j *JsonAPIAdapter) MarshalCreate(body interface{}) ([]byte, error)

+ func (j *JsonAPIAdapter) MarshalOutput(spec Spec) ([]byte, error)

+ func (j *JsonAPIAdapter) MarshalUpdate(body interface{}) ([]byte, error)

+ func (j *JsonAPIAdapter) UnMarshalInput(bs []byte, obj Object) error

+ func (j *JsonAPIAdapter) UnmarshalRead(bs []byte, o interface{}) error

+ type JsonApiInterface interface

+ MarshalApply func(body interface{}) ([]byte, error)

+ MarshalCreate func(body interface{}) ([]byte, error)

+ MarshalUpdate func(body interface{}) ([]byte, error)

+ UnmarshalRead func(bs []byte, o interface{}) error

+ type JsonFileInerface interface

+ MarshalOutput func(spec Spec) ([]byte, error)

+ UnMarshalInput func(bs []byte, obj Object) error

v0.4.0

Jul 19, 2021

v0.3.0

Jul 17, 2021

Changes in this version

+ const ErrorTypeGatewayTimeout

+ const ErrorTypeNotFound

+ const ErrorTypeParamaterError

+ const ErrorTypeSystemError

+ const ErrorTypeTooManyRequests

+ func IsBadResponse(err error, f func(b *BadResponse) bool) bool

+ func IsErrMsg(err error, msg string) bool

+ func IsErrType(err error, name string) bool

+ func IsGatewayTimeout(err error) bool

+ func IsParameterError(err error) bool

+ func IsRequestFormatError(err error) bool

+ func IsStatusCode(err error, code int) bool

+ func IsSystemError(err error) bool

+ func IsTooManyRequests(err error) bool

type BadResponse

+ StatusCode int

+ func (r *BadResponse) IsAuthError() bool

+ func (r *BadResponse) IsErrMsg(msg string) bool

+ func (r *BadResponse) IsErrType(name string) bool

+ func (r *BadResponse) IsErrorCode(code string) (bool, string)

+ func (r *BadResponse) IsErrorCodeAttribute(code string, attribute string) bool

+ func (r *BadResponse) IsGatewayTimeout() bool

+ func (r *BadResponse) IsInvalidSchema() bool

+ func (r *BadResponse) IsNotFound() bool

+ func (r *BadResponse) IsParameterError() bool

+ func (r *BadResponse) IsRequestFormatError() bool

+ func (r *BadResponse) IsStatusCode(code int) bool

+ func (r *BadResponse) IsSystemError() bool

+ func (r *BadResponse) IsTooManyRequests() bool

type Client

+ Client *http.Client

+ type ClientInterface interface

+ Apply func(s Spec, body interface{}) (requestId string, err error)

+ Cancel func(s Spec) (requestId string, err error)

+ Count func(s CountableListSpec, keywords SearchParams) (requestId string, err error)

+ Create func(s Spec, body interface{}) (requestId string, err error)

+ Delete func(s Spec) (requestId string, err error)

+ Do func(spec Spec, action Action, body interface{}, params SearchParams) (requestId string, err error)

+ List func(s ListSpec, keywords SearchParams) (requestId string, err error)

+ ListALL func(s CountableListSpec, keywords SearchParams) (requestId string, err error)

+ Read func(s Spec) (requestId string, err error)

+ Update func(s Spec, body interface{}) (requestId string, err error)

+ WatchList func(ctx context.Context, interval time.Duration, s ListSpec, keyword SearchParams) error

+ WatchListAll func(ctx context.Context, interval time.Duration, s CountableListSpec, ...) error

+ WatchRead func(ctx context.Context, interval time.Duration, s Spec) error

type StdLogger

+ func NewStdLogger(out io.Writer, prefix string, flag int, level int) *StdLogger

v0.2.0

Jul 4, 2021

v0.1.0

Jul 4, 2021

Changes in this version

+ const DefaultEndpoint

+ func IsAuthError(err error) bool

+ func IsErrorCode(err error, code string) (bool, string)

+ func IsErrorCodeAttribute(err error, code string, attribute string) bool

+ func IsInvalidSchema(err error) bool

+ func IsNotFound(err error) (bool, string)

+ func MarshalApply(body interface{}) ([]byte, error)

+ func MarshalCreate(body interface{}) ([]byte, error)

+ func MarshalMap(body interface{}) ([]byte, error)

+ func MarshalOutput(spec Spec) ([]byte, error)

+ func MarshalUpdate(body interface{}) ([]byte, error)

+ func UnMarshalInput(bs []byte, spec Spec) error

+ func UnmarshalRead(bs []byte, o interface{}) error

+ type Action string

+ var ActionApply Action = "Apply"

+ var ActionCancel Action = "Cancel"

+ var ActionCount Action = "Count"

+ var ActionCreate Action = "Create"

+ var ActionDelete Action = "Delete"

+ var ActionList Action = "List"

+ var ActionRead Action = "Read"

+ var ActionUpdate Action = "Update"

+ var Actions = []Action{ ... }

+ func (a Action) ToMethod() string

+ type AsyncResponse struct

+ JobsUrl string

+ type BadResponse struct

+ ErrorDetails ErrorDetails

+ ErrorMessage string

+ ErrorType string

+ func (r *BadResponse) Error() string

+ type Client struct

+ Endpoint string

+ LastRequest *RequestInfo

+ LastResponse *ResponseInfo

+ Token string

+ func NewClient(token string, endpoint string, logger Logger) *Client

+ func (c *Client) Apply(s Spec, body interface{}) (requestId string, err error)

+ func (c *Client) Cancel(s Spec) (requestId string, err error)

+ func (c *Client) Count(s CountableListSpec, keywords SearchParams) (requestId string, err error)

+ func (c *Client) Create(s Spec, body interface{}) (requestId string, err error)

+ func (c *Client) Delete(s Spec) (requestId string, err error)

+ func (c *Client) Do(spec Spec, action Action, body interface{}, params SearchParams) (requestId string, err error)

+ func (c *Client) List(s ListSpec, keywords SearchParams) (requestId string, err error)

+ func (c *Client) ListALL(s CountableListSpec, keywords SearchParams) (requestId string, err error)

+ func (c *Client) Read(s Spec) (requestId string, err error)

+ func (c *Client) SetLogger(l Logger) *Client

+ func (c *Client) SetWatchInterval(d time.Duration) error

+ func (c *Client) SetWatchTimeout(d time.Duration) error

+ func (c *Client) Update(s Spec, body interface{}) (requestId string, err error)

+ func (c *Client) Watch(ctx context.Context, f func() (keep bool, err error)) error

+ func (c *Client) WatchList(ctx context.Context, s ListSpec, keyword SearchParams) error

+ func (c *Client) WatchListAll(ctx context.Context, s CountableListSpec, keyword SearchParams) error

+ func (c *Client) WatchRead(ctx context.Context, s Spec) error

+ type CommonSearchParams struct

+ Limit int32

+ Offset int32

+ Type SearchType

+ func (k *CommonSearchParams) GetLimit() int32

+ func (k *CommonSearchParams) GetOffset() int32

+ func (k *CommonSearchParams) GetType() SearchType

+ func (k *CommonSearchParams) SetLimit(limit int32)

+ func (k *CommonSearchParams) SetOffset(offset int32)

+ func (k *CommonSearchParams) SetType(t SearchType)

+ func (s *CommonSearchParams) GetValues() (url.Values, error)

+ type Count struct

+ Count int32

+ func (c *Count) GetCount() int32

+ func (c *Count) SetCount(v int32)

+ type CountResponse struct

+ Result Count

+ type CountableListSpec interface

+ AddItem func(interface{}) bool

+ ClearItems func()

+ GetCount func() int32

+ GetMaxLimit func() int32

+ SetCount func(int32)

+ type ErrorDetail struct

+ Attribute string

+ Code string

+ func (e ErrorDetail) Error() string

+ type ErrorDetails []ErrorDetail

+ func (e ErrorDetails) Error() string

+ type Initializer interface

+ Init func()

+ type KeywordsBoolean []types.Boolean

+ func (c KeywordsBoolean) EncodeValues(key string, v *url.Values) error

+ type KeywordsFavorite []types.Favorite

+ func (c KeywordsFavorite) EncodeValues(key string, v *url.Values) error

+ type KeywordsId []int64

+ func (s KeywordsId) Validate() bool

+ type KeywordsState []types.State

+ func (c KeywordsState) EncodeValues(key string, v *url.Values) error

+ type KeywordsString []string

+ func (s KeywordsString) Validate() bool

+ type ListSpec interface

+ GetItems func() interface{}

+ Index func(int) interface{}

+ Len func() int

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Infof func(format string, args ...interface{})

+ Tracef func(format string, args ...interface{})

+ type Object interface

+ DeepCopyObject func() Object

+ type OutputFrame struct

+ Spec Spec

+ type RawResponse struct

+ Result json.RawMessage

+ Results json.RawMessage

+ type RequestInfo struct

+ Body []byte

+ Method string

+ Url string

+ type ResponseCommon struct

+ RequestId string

+ type ResponseInfo struct

+ Body []byte

+ Response *http.Response

+ type RowSearchParams struct

+ func NewRowSearchParams(queryString string) (*RowSearchParams, error)

+ func (r *RowSearchParams) GetValues() (url.Values, error)

+ func (r RowSearchParams) GetLimit() int32

+ func (r RowSearchParams) GetOffset() int32

+ func (r RowSearchParams) SetLimit(limit int32)

+ func (r RowSearchParams) SetOffset(offset int32)

+ type SearchDate time.Time

+ type SearchLimit int32

+ func (s SearchLimit) Validate() bool

+ type SearchOffset int32

+ func (s SearchOffset) Validate() bool

+ type SearchOrder string

+ var SearchOrderASC SearchOrder = "ASC"

+ var SearchOrderDESC SearchOrder = "DESC"

+ func (s SearchOrder) Validate() bool

+ type SearchParams interface

+ GetLimit func() int32

+ GetOffset func() int32

+ GetValues func() (url.Values, error)

+ SetLimit func(int32)

+ SetOffset func(int32)

+ type SearchTimeZone string

+ func (s SearchTimeZone) Sec() int

+ func (s SearchTimeZone) Validate() bool

+ type SearchType string

+ var SearchTypeAND SearchType = "AND"

+ var SearchTypeOR SearchType = "OR"

+ func (s SearchType) Validate() bool

+ type Spec interface

+ GetGroup func() string

+ GetName func() string

+ GetPathMethod func(Action) (string, string)

+ type StdLogger struct

+ LogLevel int

+ func (s *StdLogger) Debugf(format string, args ...interface{})

+ func (s *StdLogger) Errorf(format string, args ...interface{})

+ func (s *StdLogger) Infof(format string, args ...interface{})

+ func (s *StdLogger) Tracef(format string, args ...interface{})

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL