client

package

v0.0.0-...-5c5b994 Latest Latest Go to latest Published: Apr 2, 2024 License: Apache-2.0 Imports: 13 Imported by: 93

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/IBM-Cloud/bluemix-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package client provides a generic client to be used by all services

Index ¶

type Client
- func New(c *bluemix.Config, serviceName bluemix.ServiceName, refresher TokenProvider) *Client
type Config
type PaginatedResourcesHandler
type TokenProvider

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	Config         *bluemix.Config
	DefaultHeader  gohttp.Header
	ServiceName    bluemix.ServiceName
	TokenRefresher TokenProvider
	// contains filtered or unexported fields
}

Client is the base client for all service api client

func New ¶

func New(c *bluemix.Config, serviceName bluemix.ServiceName, refresher TokenProvider) *Client

New ...

func (*Client) Delete ¶

func (c *Client) Delete(path string, extraHeader ...interface{}) (*gohttp.Response, error)

Delete ...

func (*Client) DeleteWithBody ¶

func (c *Client) DeleteWithBody(path string, data interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

DeleteWithBody ...

func (*Client) DeleteWithResp ¶

func (c *Client) DeleteWithResp(path string, respV interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

DeleteWithResp ...

func (*Client) Get ¶

func (c *Client) Get(path string, respV interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

Get ...

func (*Client) GetPaginated ¶

func (c *Client) GetPaginated(path string, paginated PaginatedResourcesHandler, cb func(interface{}) bool) (resp *gohttp.Response, err error)

func (*Client) MakeRequest ¶

func (c *Client) MakeRequest(r *rest.Request, respV interface{}) (*gohttp.Response, error)

MakeRequest ...

func (*Client) Patch ¶

func (c *Client) Patch(path string, data interface{}, respV interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

Patch ...

func (*Client) Post ¶

func (c *Client) Post(path string, data interface{}, respV interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

Post ...

func (*Client) PostWithForm ¶

func (c *Client) PostWithForm(path string, form interface{}, respV interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

PostWithForm ...

func (*Client) Put ¶

func (c *Client) Put(path string, data interface{}, respV interface{}, extraHeader ...interface{}) (*gohttp.Response, error)

Put ...

func (*Client) SendRequest ¶

func (c *Client) SendRequest(r *rest.Request, respV interface{}) (*gohttp.Response, error)

SendRequest ...

func (*Client) URL ¶

func (c *Client) URL(path string) string

URL ...

type Config ¶

type Config struct {
	Config   *bluemix.Config
	Endpoint string
}

Config stores any generic service client configurations

type PaginatedResourcesHandler ¶

type PaginatedResourcesHandler interface {
	Resources(rawResponse []byte, curPath string) (resources []interface{}, nextPath string, err error)
}

type TokenProvider ¶

type TokenProvider interface {
	RefreshToken() (string, error)
	GetPasscode() (string, error)
	AuthenticatePassword(string, string) error
	AuthenticateAPIKey(string) error
}

TokenProvider ...

Source Files ¶

View all Source files

client.go

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