metricsstorageretention

Documentation

Overview

Package metricsstorageretention 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

• Constants
• func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
• func NewUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
• func NewUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
• type BucketRetentionTimeRespond
• type Client
  • func NewRawClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *Client[K]
  • func (c *Client[K]) ListRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
  • func (c *Client[K]) UpdateRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
  • func (c *Client[K]) UpdateRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
• type ClientWithResponses
  • func NewClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *ClientWithResponses[K]
  • func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, instanceID string, ...) (*ListResponse, error)
  • func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
  • func (c *ClientWithResponses[K]) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
  • func (c *ClientWithResponses[K]) Update(ctx context.Context, projectID string, instanceID string, ...) (*UpdateResponse, error)
  • func (c *ClientWithResponses[K]) UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*UpdateResponse, error)
• type ClientWithResponsesInterface
• type Error
• type ListResponse
  • func (r ListResponse) Status() string
  • func (r ListResponse) StatusCode() int
• type Message
• type PermissionDenied
• type RequestEditorFn
• type UpdateJSONBody
• type UpdateJSONRequestBody
• type UpdateResponse
  • func (r UpdateResponse) Status() string
  • func (r UpdateResponse) StatusCode() int

Constants

const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Functions

func NewListRequest

func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)

NewListRequest generates requests for List

func NewUpdateRequest

func NewUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, body UpdateJSONRequestBody) (*http.Request, error)

NewUpdateRequest calls the generic Update builder with application/json body

func NewUpdateRequestWithBody

func NewUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateRequestWithBody generates requests for Update with any type of body

Types

type BucketRetentionTimeRespond

type BucketRetentionTimeRespond struct {
	Message                 string `json:"message"`
	MetricsRetentionTime1h  string `json:"metricsRetentionTime1h"`
	MetricsRetentionTime5m  string `json:"metricsRetentionTime5m"`
	MetricsRetentionTimeRaw string `json:"metricsRetentionTimeRaw"`
}

BucketRetentionTimeRespond defines model for BucketRetentionTimeRespond.

type Client

type Client[K contracts.ClientFlowConfig] struct {
	// 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.ClientInterface[K]
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *Client[K]

NewRawClient Creates a new Client, with reasonable defaults

func (*Client[K]) ListRaw

func (c *Client[K]) ListRaw(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client[K]) UpdateRaw

func (c *Client[K]) UpdateRaw(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client[K]) UpdateRawWithBody

func (c *Client[K]) UpdateRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientWithResponses

type ClientWithResponses[K contracts.ClientFlowConfig] struct {
	// contains filtered or unexported fields
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient

func NewClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *ClientWithResponses[K]

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

func (*ClientWithResponses[K]) List

func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)

List request returning *ListResponse

func (*ClientWithResponses[K]) ParseListResponse

func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)

ParseListResponse parses an HTTP response from a List call

func (*ClientWithResponses[K]) ParseUpdateResponse

func (c *ClientWithResponses[K]) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)

ParseUpdateResponse parses an HTTP response from a Update call

func (*ClientWithResponses[K]) Update

func (c *ClientWithResponses[K]) Update(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)

func (*ClientWithResponses[K]) UpdateWithBody

func (c *ClientWithResponses[K]) UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)

UpdateWithBody request with arbitrary body returning *UpdateResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface[K contracts.ClientFlowConfig] interface {
	// List request
	List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)

	// Update request with any body
	UpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)

	Update(ctx context.Context, projectID string, instanceID string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Error

type Error struct {
	Errors  *[]map[string]string `json:"errors,omitempty"`
	Message string               `json:"message"`
}

Error defines model for Error.

type ListResponse

type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *BucketRetentionTimeRespond
	JSON403      *PermissionDenied
	Error        error // Aggregated error
}

func (ListResponse) Status

func (r ListResponse) Status() string

Status returns HTTPResponse.Status

func (ListResponse) StatusCode

func (r ListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Message

type Message struct {
	Message string `json:"message"`
}

Message defines model for Message.

type PermissionDenied

type PermissionDenied struct {
	Detail string `json:"detail"`
}

PermissionDenied defines model for PermissionDenied.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type UpdateJSONBody

type UpdateJSONBody struct {
	// MetricsRetentionTime1h Retention time of longtime storage of 1h sampled data. After that time the data will be deleted permanently.
	// `Additional Validators:`
	// * Should be a valid time string
	// * Should not be bigger than metricsRetentionTime5m
	MetricsRetentionTime1h string `json:"metricsRetentionTime1h"`

	// MetricsRetentionTime5m Retention time of longtime storage of 5m sampled data. After that time the data will be down sampled to 1h.
	// `Additional Validators:`
	// * Should be a valid time string
	// * Should not be bigger than metricsRetentionTimeRaw
	MetricsRetentionTime5m string `json:"metricsRetentionTime5m"`

	// MetricsRetentionTimeRaw Retention time of longtime storage of raw sampled data. After that time the data will be down sampled to 5m.
	// Keep in mind, that the initial goal of downsampling is not saving disk or object storage space. In fact, downsampling doesn't save you any space but instead, it adds 2 more blocks for each raw block which are only slightly smaller or relatively similar size to raw block. This is done by internal downsampling implementation which to be mathematically correct holds various aggregations. This means that downsampling can increase the size of your storage a bit (~3x), if you choose to store all resolutions (recommended). The goal of downsampling is to provide an opportunity to get fast results for range queries of big time intervals like months or years.
	// `Additional Validators:`
	// * Should be a valid time string
	// * Should not be bigger than 13 months
	MetricsRetentionTimeRaw string `json:"metricsRetentionTimeRaw"`
}

UpdateJSONBody defines parameters for Update.

type UpdateJSONRequestBody

type UpdateJSONRequestBody UpdateJSONBody

UpdateJSONRequestBody defines body for Update for application/json ContentType.

type UpdateResponse

type UpdateResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Message
	JSON400      *Error
	JSON403      *PermissionDenied
	Error        error // Aggregated error
}

func (UpdateResponse) Status

func (r UpdateResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateResponse) StatusCode

func (r UpdateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode