mongodbflex

Documentation

Overview

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

Code generated by dev.azure.com/schwarzit/schwarzit.odj.core/_git/stackit-client-generator.git version v1.0.23 DO NOT EDIT.

Index

• Variables
• type Client
  • func NewRawClient(server string, opts ...ClientOption) (*Client, error)
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer contracts.BaseClientInterface) ClientOption
• type ClientWithResponses
  • func NewClient(server string, opts ...ClientOption) (*ClientWithResponses, error)
  • func NewService(c contracts.BaseClientInterface) *ClientWithResponses

Variables

var BaseURLs = env.URLs(
	"mongodb_flex",
	"https://api.stackit.cloud/mongodb/v1/",
	"https://api-qa.stackit.cloud/mongodb/v1/",
	"https://api-dev.stackit.cloud/mongodb/v1/",
)

Types

type Client

type Client struct {
	// list of connected client services
	Backup   *backup.Client
	User     *user.Client
	Versions *versions.Client
	Flavors  *flavors.Client
	Instance *instance.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 contracts.BaseClientInterface
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient(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 contracts.BaseClientInterface) 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
	Backup   *backup.ClientWithResponses
	User     *user.ClientWithResponses
	Versions *versions.ClientWithResponses
	Flavors  *flavors.ClientWithResponses
	Instance *instance.ClientWithResponses
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient

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

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

func NewService

func NewService(c contracts.BaseClientInterface) *ClientWithResponses