resourcemanagement

Documentation

Overview

Package resourcemanagement provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/oapi-codegen version v0.5.1 DO NOT EDIT.

Index

• type Client
  • func NewClient(server string, opts ...ClientOption) (*Client, error)
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer common.Client) ClientOption
• type ClientWithResponses
  • func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func NewService(c common.Client) *ClientWithResponses

Types

type Client

type Client struct {
	// list of connected client services
	Projects *projects.Client
	Private  *private.Client

	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client common.Client
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer common.Client) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

type ClientWithResponses

type ClientWithResponses struct {
	Client *Client

	// list of connected client services
	Projects *projects.ClientWithResponses
	Private  *private.ClientWithResponses
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func NewService

func NewService(c common.Client) *ClientWithResponses