Documentation
¶
Index ¶
- type Client
- func (c *Client) Clone() common.Client
- func (c *Client) Do(req *http.Request) (*http.Response, error)
- func (c *Client) GetBaseURL() string
- func (c *Client) GetConfig() Config
- func (c *Client) GetHTTPClient() *http.Client
- func (c *Client) LegacyDo(req *http.Request, v interface{}, errorHandlers ...func(*http.Response) error) (*http.Response, error)
- func (c *Client) Request(ctx context.Context, method, path string, body []byte) (*http.Request, error)
- func (c *Client) SetBaseURL(url string) error
- func (c *Client) SetToken(token string)
- type Config
- type DataServices
- type IncubatorServices
- type ProductiveServices
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct { Services services // Legacy //---------- // Productive services - services that are ready to be used in production ProductiveServices // Incubator - services under development or currently being tested // not ready for production usage Incubator IncubatorServices // contains filtered or unexported fields }
Client service for managing interactions with STACKIT API
func MockServer ¶
MockServer mocks STACKIT api server and returns a client pointing to it, mux, teardown function and an error indicator
func (*Client) GetBaseURL ¶ added in v1.1.0
GetBaseURL returns the base url string
func (*Client) GetHTTPClient ¶
GetHTTPClient returns the HTTP client
func (*Client) LegacyDo ¶ added in v1.3.0
func (c *Client) LegacyDo(req *http.Request, v interface{}, errorHandlers ...func(*http.Response) error) (*http.Response, error)
LegacyDo performs the request, including retry if set To set retry, use WithRetry() which returns a shalow copy of the client
func (*Client) Request ¶
func (c *Client) Request(ctx context.Context, method, path string, body []byte) (*http.Request, error)
Request creates a new API request
func (*Client) SetBaseURL ¶ added in v1.1.0
SetBaseURL sets the base url
type Config ¶
Config is the STACKIT client configuration
type DataServices ¶ added in v1.1.0
type DataServices struct { ElasticSearch *dataservices.DataServicesService LogMe *dataservices.DataServicesService MariaDB *dataservices.DataServicesService PostgresDB *dataservices.DataServicesService RabbitMQ *dataservices.DataServicesService Redis *dataservices.DataServicesService }
type IncubatorServices ¶
type IncubatorServices struct { }
IncubatorServices is the struct representing all services that are under development
type ProductiveServices ¶
type ProductiveServices struct { Argus *argus.ArgusService Costs *costs.CostsService DataServices DataServices Kubernetes *kubernetes.KubernetesService Membership *membership.MembershipService MongoDBFlex *mongodbFlex.MongoDBService ObjectStorage *objectstorage.ObjectStorageService PostgresFlex *postgresFlex.PostgresService ResourceManagement *resourceManagement.ResourceManagementService }
ProductiveServices is the struct representing all productive services
Directories
¶
Path | Synopsis |
---|---|
examples
|
|
internal
|
|
common
client file in package common holds the client interface and service struct used by each service that the client is connecting with services using the Service struct are located under pkg/api
|
client file in package common holds the client interface and service struct used by each service that the client is connecting with services using the Service struct are located under pkg/api |
pkg
|
|
api/v2/membership/roles
package roles is used for creating and managing custom roles (and permissions assigned to them)
|
package roles is used for creating and managing custom roles (and permissions assigned to them) |
services/kubernetes/v1.0/generated
Package kubernetes provides primitives to interact with the openapi HTTP API.
|
Package kubernetes provides primitives to interact with the openapi HTTP API. |
services/kubernetes/v1.0/generated/cluster
Package cluster provides primitives to interact with the openapi HTTP API.
|
Package cluster provides primitives to interact with the openapi HTTP API. |
services/kubernetes/v1.0/generated/credentials
Package credentials provides primitives to interact with the openapi HTTP API.
|
Package credentials provides primitives to interact with the openapi HTTP API. |
services/kubernetes/v1.0/generated/operation
Package operation provides primitives to interact with the openapi HTTP API.
|
Package operation provides primitives to interact with the openapi HTTP API. |
services/kubernetes/v1.0/generated/project
Package project provides primitives to interact with the openapi HTTP API.
|
Package project provides primitives to interact with the openapi HTTP API. |
services/kubernetes/v1.0/generated/provider-options
Package provideroptions provides primitives to interact with the openapi HTTP API.
|
Package provideroptions provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated
Package postgresflex provides primitives to interact with the openapi HTTP API.
|
Package postgresflex provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated/backups
Package backups provides primitives to interact with the openapi HTTP API.
|
Package backups provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated/flavors
Package flavors provides primitives to interact with the openapi HTTP API.
|
Package flavors provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated/instance
Package instance provides primitives to interact with the openapi HTTP API.
|
Package instance provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated/storage
Package storage provides primitives to interact with the openapi HTTP API.
|
Package storage provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated/users
Package users provides primitives to interact with the openapi HTTP API.
|
Package users provides primitives to interact with the openapi HTTP API. |
services/postgres-flex/v1.0/generated/versions
Package versions provides primitives to interact with the openapi HTTP API.
|
Package versions provides primitives to interact with the openapi HTTP API. |