client

Aug 12, 2024

Changes in this version

type BuildOption

+ Retry *RetryOption

type RetryOption

+ StatusCodes []int64

+ type SecurityOption interface

May 19, 2024

Changes in this version

type Client

+ func (c *Client) SetLoggerContext(ctx context.Context)

Dec 1, 2023

Changes in this version

type Client

+ func (c *Client) ReadDS(ctx context.Context, path string, opt ReadOptionDS) (*resty.Response, error)

type CreateOption

+ Retry *RetryOption

type DeleteOption

+ Retry *RetryOption

type OperationOption

+ Retry *RetryOption

type Pollable

+ func NewPollableForPoll(resp resty.Response, opt PollOption) (*Pollable, error)

+ func NewPollableForPrecheck(opt PollOption) (*Pollable, error)

type ReadOption

+ Retry *RetryOption

+ type ReadOptionDS struct

+ Header Header

+ Method string

+ Query Query

+ Retry *RetryOption

+ type RetryOption struct

+ Count int

+ MaxWaitTime time.Duration

+ Status PollingStatus

+ StatusLocator ValueLocator

+ WaitTime time.Duration

type UpdateOption

+ Retry *RetryOption

Apr 26, 2023

Changes in this version

type BuildOption

+ TLSConfig tls.Config

Dec 28, 2022

Changes in this version

type BodyLocator

+ func (loc BodyLocator) LocateValueInResp(resp resty.Response) string

type CodeLocator

+ func (loc CodeLocator) LocateValueInResp(resp resty.Response) string

type ExactLocator

+ func (loc ExactLocator) LocateValueInResp(_ resty.Response) string

type HeaderLocator

+ func (loc HeaderLocator) LocateValueInResp(resp resty.Response) string

type PollOption

+ Query Query

type Pollable

+ Query Query

type ValueLocator

+ LocateValueInResp func(resty.Response) string

Dec 6, 2022

Changes in this version

type BuildOption

+ CookieEnabled bool

+ type HTTPBasicOption struct

+ Password string

+ Username string

+ type HTTPTokenOption struct

+ Scheme string

+ Token string

type OAuth2ClientCredentialOption

+ ClientId string

type OAuth2PasswordOption

+ ClientId string

+ ClientSecret string

+ type OAuth2RefreshTokenOption struct

+ AuthStyle OAuth2AuthStyle

+ ClientId string

+ ClientSecret string

+ RefreshToken string

+ Scopes []string

+ TokenType string

+ TokenURL string

type PollOption

+ Header Header

type Pollable

+ Header Header

+ func NewPollableFromResp(resp resty.Response, opt PollOption) (*Pollable, error)

Nov 24, 2022

Changes in this version

type CreateOption

+ Method string

type DeleteOption

+ Method string

type UpdateOption

+ Method string

Nov 2, 2022

Changes in this version

type UpdateOption

+ CreateMethod string

Aug 24, 2022

Changes in this version

type Client

+ func (c *Client) Operation(ctx context.Context, path string, body interface{}, opt OperationOption) (*resty.Response, error)

+ type ExactLocator string

+ func (loc ExactLocator) String() string

+ type OperationOption struct

+ Header Header

+ Method string

+ PollOpt *PollOption

+ Query Query

type UpdateOption

+ MergePatchDisabled bool

Jun 22, 2022

Changes in this version

type UpdateOption

+ UpdateMethod string

Jun 8, 2022

Changes in this version

+ type APIKeyAuthIn string

+ const APIKeyAuthInCookie

+ const APIKeyAuthInHeader

+ const APIKeyAuthInQuery

+ type APIKeyAuthOpt struct

+ In APIKeyAuthIn

+ Name string

+ Value string

+ type APIKeyAuthOption []APIKeyAuthOpt

+ type BodyLocator string

+ func (loc BodyLocator) String() string

+ type BuildOption struct

+ Security securityOption

+ type Client struct

+ func New(baseURL string, opt *BuildOption) (*Client, error)

+ func (c *Client) Create(ctx context.Context, path string, body interface{}, opt CreateOption) (*resty.Response, error)

+ func (c *Client) Delete(ctx context.Context, path string, opt DeleteOption) (*resty.Response, error)

+ func (c *Client) Read(ctx context.Context, path string, opt ReadOption) (*resty.Response, error)

+ func (c *Client) Update(ctx context.Context, path string, body interface{}, opt UpdateOption) (*resty.Response, error)

+ type CodeLocator struct

+ func (loc CodeLocator) String() string

+ type CreateOption struct

+ CreateMethod string

+ Header Header

+ PollOpt *PollOption

+ Query Query

+ type DeleteOption struct

+ Header Header

+ PollOpt *PollOption

+ Query Query

+ type HTTPAuthOption struct

+ Password string

+ Token string

+ Type HTTPAuthType

+ Username string

+ type HTTPAuthType string

+ const HTTPAuthTypeBasic

+ const HTTPAuthTypeBearer

+ type Header map[string]string

+ func (h Header) Clone() Header

+ func (h Header) TakeOrSelf(ctx context.Context, v types.Map) Header

+ func (h Header) ToTFValue() types.Map

+ type HeaderLocator string

+ func (loc HeaderLocator) String() string

+ type OAuth2AuthStyle string

+ const OAuth2AuthStyleInHeader

+ const OAuth2AuthStyleInParams

+ type OAuth2ClientCredentialOption struct

+ AuthStyle OAuth2AuthStyle

+ ClientID string

+ ClientSecret string

+ EndpointParams map[string][]string

+ Scopes []string

+ TokenURL string

+ type OAuth2PasswordOption struct

+ AuthStyle OAuth2AuthStyle

+ Password string

+ Scopes []string

+ TokenURL string

+ Username string

+ func (opt OAuth2PasswordOption) Token() (*oauth2.Token, error)

+ type PollOption struct

+ DefaultDelay time.Duration

+ Status PollingStatus

+ StatusLocator ValueLocator

+ UrlLocator ValueLocator

+ type Pollable struct

+ DefaultDelay time.Duration

+ InitDelay time.Duration

+ Status PollingStatus

+ StatusLocator ValueLocator

+ URL string

+ func NewPollable(resp resty.Response, opt PollOption) (*Pollable, error)

+ func (f *Pollable) PollUntilDone(ctx context.Context, client *Client) error

+ type PollingStatus struct

+ Pending []string

+ Success string

+ type Query url.Values

+ func (q Query) Clone() Query

+ func (q Query) TakeOrSelf(ctx context.Context, v types.Map) Query

+ func (q Query) ToTFValue() types.Map

+ type ReadOption struct

+ Header Header

+ Query Query

+ type UpdateOption struct

+ Header Header

+ PollOpt *PollOption

+ Query Query

+ type ValueLocator interface

+ String func() string