Documentation ¶
Index ¶
- Constants
- func IsAuthError(err error) bool
- 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 IsErrorCode(err error, code string) (bool, string)
- func IsErrorCodeAttribute(err error, code string, attribute string) bool
- func IsGatewayTimeout(err error) bool
- func IsInvalidSchema(err error) bool
- func IsNotFound(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
- func MarshalApply(body interface{}) ([]byte, error)
- func MarshalCreate(body interface{}) ([]byte, error)
- func MarshalOutput(spec Spec) ([]byte, error)
- func MarshalUpdate(body interface{}) ([]byte, error)
- func UnMarshalInput(bs []byte, obj Object) error
- func UnmarshalRead(bs []byte, o interface{}) error
- type Action
- type AsyncResponse
- type BadResponse
- func (r *BadResponse) Error() string
- 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
- 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) Update(s Spec, body interface{}) (requestId string, err error)
- func (c *Client) WatchList(ctx context.Context, interval time.Duration, s ListSpec, keyword SearchParams) error
- func (c *Client) WatchListAll(ctx context.Context, interval time.Duration, s CountableListSpec, ...) error
- func (c *Client) WatchRead(ctx context.Context, interval time.Duration, s Spec) error
- type ClientInterface
- type CommonSearchParams
- func (k *CommonSearchParams) GetLimit() int32
- func (k *CommonSearchParams) GetOffset() int32
- func (k *CommonSearchParams) GetType() SearchType
- func (s *CommonSearchParams) GetValues() (url.Values, error)
- func (k *CommonSearchParams) SetLimit(limit int32)
- func (k *CommonSearchParams) SetOffset(offset int32)
- func (k *CommonSearchParams) SetType(t SearchType)
- type Count
- type CountResponse
- type CountableListSpec
- type ErrorDetail
- type ErrorDetails
- type Initializer
- type KeywordsBoolean
- type KeywordsFavorite
- type KeywordsId
- type KeywordsState
- type KeywordsString
- type ListSpec
- type Logger
- type Object
- type OutputFrame
- type RawResponse
- type RequestInfo
- type ResponseCommon
- type ResponseInfo
- type RowSearchParams
- type SearchDate
- type SearchLimit
- type SearchOffset
- type SearchOrder
- type SearchParams
- type SearchType
- type Spec
- type StdLogger
Constants ¶
View Source
const ( ErrorTypeParamaterError string = "ParameterError" ErrorTypeNotFound string = "NotFound" ErrorTypeTooManyRequests string = "TooManyRequests" ErrorTypeSystemError string = "SystemError" ErrorTypeGatewayTimeout string = "GatewayTimeout" )
View Source
const DefaultEndpoint = "https://api.dns-platform.jp/dpf/v1"
Variables ¶
This section is empty.
Functions ¶
func IsAuthError ¶
func IsBadResponse ¶ added in v0.3.0
func IsBadResponse(err error, f func(b *BadResponse) bool) bool
func IsErrorCodeAttribute ¶
func IsGatewayTimeout ¶ added in v0.3.0
func IsInvalidSchema ¶
func IsNotFound ¶
func IsParameterError ¶ added in v0.3.0
func IsRequestFormatError ¶ added in v0.3.0
func IsStatusCode ¶ added in v0.3.0
func IsSystemError ¶ added in v0.3.0
func IsTooManyRequests ¶ added in v0.3.0
func MarshalCreate ¶
Marshal for create request
func MarshalUpdate ¶
Marshal for update request
Types ¶
type Action ¶
type Action string
var ( ActionCreate Action = "Create" ActionRead Action = "Read" ActionList Action = "List" ActionUpdate Action = "Update" ActionDelete Action = "Delete" ActionCount Action = "Count" ActionCancel Action = "Cancel" ActionApply Action = "Apply" Actions = []Action{ ActionCreate, ActionRead, ActionList, ActionUpdate, ActionDelete, ActionCount, ActionCancel, ActionApply, } )
type AsyncResponse ¶
type AsyncResponse struct { ResponseCommon `read:",inline"` JobsUrl string `read:"jobs_url"` }
type BadResponse ¶
type BadResponse struct { ResponseCommon `read:",inline"` StatusCode int `read:"-"` ErrorType string `read:"error_type"` ErrorMessage string `read:"error_message"` ErrorDetails ErrorDetails `read:"error_details"` }
func (*BadResponse) Error ¶
func (r *BadResponse) Error() string
func (*BadResponse) IsAuthError ¶ added in v0.3.0
func (r *BadResponse) IsAuthError() bool
func (*BadResponse) IsErrMsg ¶ added in v0.3.0
func (r *BadResponse) IsErrMsg(msg string) bool
func (*BadResponse) IsErrType ¶ added in v0.3.0
func (r *BadResponse) IsErrType(name string) bool
func (*BadResponse) IsErrorCode ¶ added in v0.3.0
func (r *BadResponse) IsErrorCode(code string) (bool, string)
func (*BadResponse) IsErrorCodeAttribute ¶ added in v0.3.0
func (r *BadResponse) IsErrorCodeAttribute(code string, attribute string) bool
func (*BadResponse) IsGatewayTimeout ¶ added in v0.3.0
func (r *BadResponse) IsGatewayTimeout() bool
func (*BadResponse) IsInvalidSchema ¶ added in v0.3.0
func (r *BadResponse) IsInvalidSchema() bool
func (*BadResponse) IsNotFound ¶ added in v0.3.0
func (r *BadResponse) IsNotFound() bool
func (*BadResponse) IsParameterError ¶ added in v0.3.0
func (r *BadResponse) IsParameterError() bool
func (*BadResponse) IsRequestFormatError ¶ added in v0.3.0
func (r *BadResponse) IsRequestFormatError() bool
func (*BadResponse) IsStatusCode ¶ added in v0.3.0
func (r *BadResponse) IsStatusCode(code int) bool
func (*BadResponse) IsSystemError ¶ added in v0.3.0
func (r *BadResponse) IsSystemError() bool
func (*BadResponse) IsTooManyRequests ¶ added in v0.3.0
func (r *BadResponse) IsTooManyRequests() bool
type Client ¶
type Client struct { Endpoint string Token string Client *http.Client LastRequest *RequestInfo LastResponse *ResponseInfo // contains filtered or unexported fields }
func (*Client) Count ¶
func (c *Client) Count(s CountableListSpec, keywords SearchParams) (requestId string, err error)
func (*Client) List ¶
func (c *Client) List(s ListSpec, keywords SearchParams) (requestId string, err error)
func (*Client) ListALL ¶
func (c *Client) ListALL(s CountableListSpec, keywords SearchParams) (requestId string, err error)
func (*Client) WatchList ¶
func (c *Client) WatchList(ctx context.Context, interval time.Duration, s ListSpec, keyword SearchParams) error
ctx should set Deadline or Timeout interval must be grater than equals to 1s s is ListAble Spec
func (*Client) WatchListAll ¶
func (c *Client) WatchListAll(ctx context.Context, interval time.Duration, s CountableListSpec, keyword SearchParams) error
ctx should set Deadline or Timeout interval must be grater than equals to 1s s is CountableListSpec Spec
type ClientInterface ¶ added in v0.3.0
type ClientInterface interface { Do(spec Spec, action Action, body interface{}, params SearchParams) (requestId string, err error) Read(s Spec) (requestId string, err error) List(s ListSpec, keywords SearchParams) (requestId string, err error) ListALL(s CountableListSpec, keywords SearchParams) (requestId string, err error) Count(s CountableListSpec, keywords SearchParams) (requestId string, err error) Update(s Spec, body interface{}) (requestId string, err error) Create(s Spec, body interface{}) (requestId string, err error) Apply(s Spec, body interface{}) (requestId string, err error) Delete(s Spec) (requestId string, err error) Cancel(s Spec) (requestId string, err error) WatchRead(ctx context.Context, interval time.Duration, s Spec) error WatchList(ctx context.Context, interval time.Duration, s ListSpec, keyword SearchParams) error WatchListAll(ctx context.Context, interval time.Duration, s CountableListSpec, keyword SearchParams) error }
type CommonSearchParams ¶
type CommonSearchParams struct { Type SearchType `url:"type,omitempty"` Offset int32 `url:"offset,omitempty"` Limit int32 `url:"limit,omitempty"` }
func (*CommonSearchParams) GetLimit ¶
func (k *CommonSearchParams) GetLimit() int32
func (*CommonSearchParams) GetOffset ¶
func (k *CommonSearchParams) GetOffset() int32
func (*CommonSearchParams) GetType ¶
func (k *CommonSearchParams) GetType() SearchType
func (*CommonSearchParams) SetLimit ¶
func (k *CommonSearchParams) SetLimit(limit int32)
func (*CommonSearchParams) SetOffset ¶
func (k *CommonSearchParams) SetOffset(offset int32)
func (*CommonSearchParams) SetType ¶
func (k *CommonSearchParams) SetType(t SearchType)
type CountResponse ¶
type CountResponse struct { ResponseCommon `read:",inline"` Result Count `read:"result"` }
type CountableListSpec ¶
type ErrorDetail ¶
func (ErrorDetail) Error ¶
func (e ErrorDetail) Error() string
type ErrorDetails ¶
type ErrorDetails []ErrorDetail
func (ErrorDetails) Error ¶
func (e ErrorDetails) Error() string
type Initializer ¶
type Initializer interface {
Init()
}
type KeywordsBoolean ¶
+k8s:deepcopy-gen=false
func (KeywordsBoolean) EncodeValues ¶
func (c KeywordsBoolean) EncodeValues(key string, v *url.Values) error
type KeywordsFavorite ¶
+k8s:deepcopy-gen=false
func (KeywordsFavorite) EncodeValues ¶
func (c KeywordsFavorite) EncodeValues(key string, v *url.Values) error
type KeywordsId ¶
type KeywordsId []int64
+k8s:deepcopy-gen=false
func (KeywordsId) Validate ¶
func (s KeywordsId) Validate() bool
type KeywordsState ¶
+k8s:deepcopy-gen=false
func (KeywordsState) EncodeValues ¶
func (c KeywordsState) EncodeValues(key string, v *url.Values) error
type KeywordsString ¶
type KeywordsString []string
+k8s:deepcopy-gen=false
func (KeywordsString) Validate ¶
func (s KeywordsString) Validate() bool
type ListSpec ¶
type ListSpec interface { Spec Initializer GetItems() interface{} Len() int Index(int) interface{} }
type Logger ¶
type Logger interface { Tracef(format string, args ...interface{}) Debugf(format string, args ...interface{}) Infof(format string, args ...interface{}) Errorf(format string, args ...interface{}) }
logger interface
type OutputFrame ¶
type OutputFrame struct { meta.KindVersion `json:",inline"` Spec Object `json:"spec"` }
file format frame
type RawResponse ¶
type RawResponse struct { ResponseCommon `read:",inline"` Result json.RawMessage `read:"result"` Results json.RawMessage `read:"results"` }
type RequestInfo ¶
type ResponseCommon ¶
type ResponseCommon struct {
RequestId string `read:"request_id"`
}
type ResponseInfo ¶
type RowSearchParams ¶
func NewRowSearchParams ¶
func NewRowSearchParams(queryString string) (*RowSearchParams, error)
func (RowSearchParams) GetLimit ¶
func (r RowSearchParams) GetLimit() int32
func (RowSearchParams) GetOffset ¶
func (r RowSearchParams) GetOffset() int32
func (RowSearchParams) SetLimit ¶
func (r RowSearchParams) SetLimit(limit int32)
func (RowSearchParams) SetOffset ¶
func (r RowSearchParams) SetOffset(offset int32)
type SearchLimit ¶
type SearchLimit int32
+k8s:deepcopy-gen=false
func (SearchLimit) Validate ¶
func (s SearchLimit) Validate() bool
type SearchOffset ¶
type SearchOffset int32
+k8s:deepcopy-gen=false
func (SearchOffset) Validate ¶
func (s SearchOffset) Validate() bool
type SearchOrder ¶
type SearchOrder string
+k8s:deepcopy-gen=false
var ( SearchOrderASC SearchOrder = "ASC" SearchOrderDESC SearchOrder = "DESC" )
func (SearchOrder) Validate ¶
func (s SearchOrder) Validate() bool
type SearchParams ¶
type SearchType ¶
type SearchType string
+k8s:deepcopy-gen=false
var ( SearchTypeAND SearchType = "AND" SearchTypeOR SearchType = "OR" )
func (SearchType) Validate ¶
func (s SearchType) Validate() bool
type StdLogger ¶
simple logger change better logger as you like.
func NewStdLogger ¶ added in v0.3.0
Click to show internal directories.
Click to hide internal directories.