rest

package
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 10, 2025 License: Apache-2.0 Imports: 8 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsAdminError 

func IsAdminError(err error) bool

Types

type Client 

type Client struct {
	ServiceURL  string
	HTTPClient  *http.Client
	VersionInfo string
}

Client is a base client that is used to make http request to the ServiceURL

func (*Client) Delete 

func (c *Client) Delete(endpoint string) error

func (*Client) DeleteWithContext added in v0.17.0 

func (c *Client) DeleteWithContext(ctx context.Context, endpoint string) error

func (*Client) DeleteWithQueryParams 

func (c *Client) DeleteWithQueryParams(endpoint string, params map[string]string) error

func (*Client) DeleteWithQueryParamsWithContext added in v0.17.0 

func (c *Client) DeleteWithQueryParamsWithContext(
	ctx context.Context,
	endpoint string,
	params map[string]string,
) error

func (*Client) Get 

func (c *Client) Get(endpoint string, obj interface{}) error

func (*Client) GetWithContext added in v0.17.0 

func (c *Client) GetWithContext(ctx context.Context, endpoint string, obj interface{}) error

func (*Client) GetWithOptions 

func (c *Client) GetWithOptions(endpoint string, obj interface{}, params map[string]string,
	decode bool, file io.Writer) ([]byte, error)

func (*Client) GetWithOptionsWithContext added in v0.17.0 

func (c *Client) GetWithOptionsWithContext(
	ctx context.Context,
	endpoint string,
	obj interface{},
	params map[string]string,
	decode bool, file io.Writer,
) ([]byte, error)

func (*Client) GetWithQueryParams 

func (c *Client) GetWithQueryParams(endpoint string, obj interface{}, params map[string]string,
	decode bool) ([]byte, error)

func (*Client) GetWithQueryParamsWithContext added in v0.17.0 

func (c *Client) GetWithQueryParamsWithContext(
	ctx context.Context,
	endpoint string,
	obj interface{},
	params map[string]string,
	decode bool,
) ([]byte, error)

func (*Client) MakeRequest 

func (c *Client) MakeRequest(method, endpoint string) (*http.Response, error)

MakeRequest can make a simple request and handle the response by yourself

func (*Client) MakeRequestWithContext added in v0.17.0 

func (c *Client) MakeRequestWithContext(ctx context.Context, method, endpoint string) (*http.Response, error)

MakeRequestWithContext can make a simple request and handle the response by yourself

func (*Client) MakeRequestWithURL added in v0.13.0 

func (c *Client) MakeRequestWithURL(method string, urlOpt *url.URL) (*http.Response, error)

func (*Client) MakeRequestWithURLWithContext added in v0.17.0 

func (c *Client) MakeRequestWithURLWithContext(
	ctx context.Context,
	method string,
	urlOpt *url.URL,
) (*http.Response, error)

func (*Client) Post 

func (c *Client) Post(endpoint string, in interface{}) error

func (*Client) PostWithContext added in v0.17.0 

func (c *Client) PostWithContext(ctx context.Context, endpoint string, in interface{}) error

func (*Client) PostWithMultiPart 

func (c *Client) PostWithMultiPart(endpoint string, in interface{}, body io.Reader, contentType string) error

func (*Client) PostWithMultiPartWithContext added in v0.17.0 

func (c *Client) PostWithMultiPartWithContext(
	ctx context.Context,
	endpoint string,
	in interface{},
	body io.Reader,
	contentType string,
) error

func (*Client) PostWithObj 

func (c *Client) PostWithObj(endpoint string, in, obj interface{}) error

func (*Client) PostWithObjWithContext added in v0.17.0 

func (c *Client) PostWithObjWithContext(ctx context.Context, endpoint string, in, obj interface{}) error

func (*Client) PostWithQueryParams 

func (c *Client) PostWithQueryParams(endpoint string, in interface{}, params map[string]string) error

func (*Client) PostWithQueryParamsWithContext added in v0.17.0 

func (c *Client) PostWithQueryParamsWithContext(
	ctx context.Context,
	endpoint string,
	in interface{},
	params map[string]string,
) error

func (*Client) Put 

func (c *Client) Put(endpoint string, in interface{}) error

func (*Client) PutWithContext added in v0.17.0 

func (c *Client) PutWithContext(ctx context.Context, endpoint string, in interface{}) error

func (*Client) PutWithCustomMediaType added in v0.13.0 

func (c *Client) PutWithCustomMediaType(
	endpoint string,
	in, obj interface{},
	params map[string]string,
	mediaType MediaType,
) error

func (*Client) PutWithCustomMediaTypeWithContext added in v0.17.0 

func (c *Client) PutWithCustomMediaTypeWithContext(
	ctx context.Context,
	endpoint string,
	in,
	obj interface{},
	params map[string]string,
	mediaType MediaType,
) error

func (*Client) PutWithMultiPart 

func (c *Client) PutWithMultiPart(
	endpoint string,
	body io.Reader,
	contentType string,
) error

func (*Client) PutWithMultiPartWithContext added in v0.17.0 

func (c *Client) PutWithMultiPartWithContext(
	ctx context.Context,
	endpoint string,
	body io.Reader,
	contentType string,
) error

func (*Client) PutWithQueryParams 

func (c *Client) PutWithQueryParams(endpoint string, in, obj interface{}, params map[string]string) error

func (*Client) PutWithQueryParamsWithContext added in v0.17.0 

func (c *Client) PutWithQueryParamsWithContext(
	ctx context.Context,
	endpoint string,
	in,
	obj interface{},
	params map[string]string,
) error

type Error 

type Error struct {
	Reason string `json:"reason"`
	Code   int
}

Error is a admin error type

func (Error) Error 

func (e Error) Error() string

type MediaType added in v0.13.0 

type MediaType string
const (
	ApplicationJSON          MediaType = "application/json"
	PartitionedTopicMetaJSON MediaType = "application/vnd.partitioned-topic-metadata+json"
)

func (MediaType) String added in v0.13.0 

func (m MediaType) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.