Documentation
¶
Overview ¶
Package logs 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 NewConfigListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
- func NewConfigUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewConfigUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewCreateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewDeleteRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- 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 AlertGroupJson
- type AlertGroupResponse
- type AlertGroupsResponse
- type AlertRuleRecordJson
- type Client
- func (c *Client) ConfigListRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) ConfigUpdateRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) ConfigUpdateRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- func (c *Client) CreateRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) CreateRawWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*http.Response, error)
- func (c *Client) DeleteRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client) GetRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client) ListRaw(ctx context.Context, projectID string, instanceID string, ...) (*http.Response, error)
- func (c *Client) UpdateRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client) UpdateRawWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- type ClientWithResponses
- func (c *ClientWithResponses) ConfigList(ctx context.Context, projectID string, instanceID string, ...) (*ConfigListResponse, error)
- func (c *ClientWithResponses) ConfigUpdate(ctx context.Context, projectID string, instanceID string, ...) (*ConfigUpdateResponse, error)
- func (c *ClientWithResponses) ConfigUpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*ConfigUpdateResponse, error)
- func (c *ClientWithResponses) Create(ctx context.Context, projectID string, instanceID string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses) CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses) Delete(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*DeleteResponse, error)
- func (c *ClientWithResponses) Get(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*GetResponse, error)
- func (c *ClientWithResponses) List(ctx context.Context, projectID string, instanceID string, ...) (*ListResponse, error)
- func (c *ClientWithResponses) ParseConfigListResponse(rsp *http.Response) (*ConfigListResponse, error)
- func (c *ClientWithResponses) ParseConfigUpdateResponse(rsp *http.Response) (*ConfigUpdateResponse, error)
- func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
- func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
- func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
- func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
- func (c *ClientWithResponses) Update(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*UpdateResponse, error)
- func (c *ClientWithResponses) UpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*UpdateResponse, error)
- type ClientWithResponsesInterface
- type ConfigListResponse
- type ConfigUpdateJSONBody
- type ConfigUpdateJSONRequestBody
- type ConfigUpdateResponse
- type CreateJSONBody
- type CreateJSONRequestBody
- type CreateResponse
- type DeleteResponse
- type Error
- type GetResponse
- type ListResponse
- type LogsConfig
- type LogsConfigResponse
- type Message
- type PermissionDenied
- type RequestEditorFn
- type UpdateJSONBody
- type UpdateJSONRequestBody
- type UpdateResponse
Constants ¶
const (
BearerAuthScopes = "bearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewConfigListRequest ¶
func NewConfigListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
NewConfigListRequest generates requests for ConfigList
func NewConfigUpdateRequest ¶
func NewConfigUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, body ConfigUpdateJSONRequestBody) (*http.Request, error)
NewConfigUpdateRequest calls the generic ConfigUpdate builder with application/json body
func NewConfigUpdateRequestWithBody ¶
func NewConfigUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)
NewConfigUpdateRequestWithBody generates requests for ConfigUpdate with any type of body
func NewCreateRequest ¶
func NewCreateRequest(ctx context.Context, server string, projectID string, instanceID string, body CreateJSONRequestBody) (*http.Request, error)
NewCreateRequest calls the generic Create builder with application/json body
func NewCreateRequestWithBody ¶
func NewCreateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, contentType string, body io.Reader) (*http.Request, error)
NewCreateRequestWithBody generates requests for Create with any type of body
func NewDeleteRequest ¶
func NewDeleteRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string) (*http.Request, error)
NewDeleteRequest generates requests for Delete
func NewGetRequest ¶
func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string) (*http.Request, error)
NewGetRequest generates requests for Get
func NewListRequest ¶
func NewListRequest(ctx context.Context, server string, projectID string, instanceID string) (*http.Request, error)
NewListRequest generates requests for List
Types ¶
type AlertGroupJson ¶
type AlertGroupJson struct { Interval *string `json:"interval,omitempty"` Name string `json:"name"` Rules []AlertRuleRecordJson `json:"rules"` }
AlertGroupJson defines model for AlertGroupJson.
type AlertGroupResponse ¶
type AlertGroupResponse struct { Data AlertGroupJson `json:"data"` Message string `json:"message"` }
AlertGroupResponse defines model for AlertGroupResponse.
type AlertGroupsResponse ¶
type AlertGroupsResponse struct { Data []AlertGroupJson `json:"data"` Message string `json:"message"` }
AlertGroupsResponse defines model for AlertGroupsResponse.
type AlertRuleRecordJson ¶
type AlertRuleRecordJson struct { Alert *string `json:"alert,omitempty"` Annotations *map[string]string `json:"annotations,omitempty"` Expr string `json:"expr"` For *string `json:"for,omitempty"` Labels *map[string]string `json:"labels,omitempty"` Record *string `json:"record,omitempty"` }
AlertRuleRecordJson defines model for AlertRuleRecordJson.
type Client ¶
type Client 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.BaseClientInterface }
Client which conforms to the OpenAPI3 specification for this service.
func NewRawClient ¶
func NewRawClient(server string, httpClient contracts.BaseClientInterface) *Client
NewRawClient Creates a new Client, with reasonable defaults
func (*Client) ConfigListRaw ¶
func (*Client) ConfigUpdateRaw ¶
func (c *Client) ConfigUpdateRaw(ctx context.Context, projectID string, instanceID string, body ConfigUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) ConfigUpdateRawWithBody ¶
func (*Client) CreateRaw ¶
func (c *Client) CreateRaw(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) CreateRawWithBody ¶
type ClientWithResponses ¶
type ClientWithResponses struct {
// contains filtered or unexported fields
}
ClientWithResponses builds on rawClientInterface to offer response payloads
func NewClient ¶
func NewClient(server string, httpClient contracts.BaseClientInterface) *ClientWithResponses
NewClient creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) ConfigList ¶
func (c *ClientWithResponses) ConfigList(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ConfigListResponse, error)
ConfigList request returning *ConfigListResponse
func (*ClientWithResponses) ConfigUpdate ¶
func (c *ClientWithResponses) ConfigUpdate(ctx context.Context, projectID string, instanceID string, body ConfigUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfigUpdateResponse, error)
func (*ClientWithResponses) ConfigUpdateWithBody ¶
func (c *ClientWithResponses) ConfigUpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfigUpdateResponse, error)
ConfigUpdateWithBody request with arbitrary body returning *ConfigUpdateResponse
func (*ClientWithResponses) Create ¶
func (c *ClientWithResponses) Create(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
func (*ClientWithResponses) CreateWithBody ¶
func (c *ClientWithResponses) CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error)
CreateWithBody request with arbitrary body returning *CreateResponse
func (*ClientWithResponses) Delete ¶
func (c *ClientWithResponses) Delete(ctx context.Context, projectID string, instanceID string, groupName string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
Delete request returning *DeleteResponse
func (*ClientWithResponses) Get ¶
func (c *ClientWithResponses) Get(ctx context.Context, projectID string, instanceID string, groupName string, reqEditors ...RequestEditorFn) (*GetResponse, error)
Get request returning *GetResponse
func (*ClientWithResponses) List ¶
func (c *ClientWithResponses) List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error)
List request returning *ListResponse
func (*ClientWithResponses) ParseConfigListResponse ¶
func (c *ClientWithResponses) ParseConfigListResponse(rsp *http.Response) (*ConfigListResponse, error)
ParseConfigListResponse parses an HTTP response from a ConfigList call
func (*ClientWithResponses) ParseConfigUpdateResponse ¶
func (c *ClientWithResponses) ParseConfigUpdateResponse(rsp *http.Response) (*ConfigUpdateResponse, error)
ParseConfigUpdateResponse parses an HTTP response from a ConfigUpdate call
func (*ClientWithResponses) ParseCreateResponse ¶
func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
ParseCreateResponse parses an HTTP response from a Create call
func (*ClientWithResponses) ParseDeleteResponse ¶
func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
ParseDeleteResponse parses an HTTP response from a Delete call
func (*ClientWithResponses) ParseGetResponse ¶
func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a Get call
func (*ClientWithResponses) ParseListResponse ¶
func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
ParseListResponse parses an HTTP response from a List call
func (*ClientWithResponses) ParseUpdateResponse ¶
func (c *ClientWithResponses) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
ParseUpdateResponse parses an HTTP response from a Update call
func (*ClientWithResponses) Update ¶
func (c *ClientWithResponses) Update(ctx context.Context, projectID string, instanceID string, groupName string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
func (*ClientWithResponses) UpdateWithBody ¶
func (c *ClientWithResponses) UpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
UpdateWithBody request with arbitrary body returning *UpdateResponse
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // List request List(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ListResponse, error) // Create request with any body CreateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error) Create(ctx context.Context, projectID string, instanceID string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error) // Delete request Delete(ctx context.Context, projectID string, instanceID string, groupName string, reqEditors ...RequestEditorFn) (*DeleteResponse, error) // Get request Get(ctx context.Context, projectID string, instanceID string, groupName string, reqEditors ...RequestEditorFn) (*GetResponse, error) // Update request with any body UpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error) Update(ctx context.Context, projectID string, instanceID string, groupName string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error) // ConfigList request ConfigList(ctx context.Context, projectID string, instanceID string, reqEditors ...RequestEditorFn) (*ConfigListResponse, error) // ConfigUpdate request with any body ConfigUpdateWithBody(ctx context.Context, projectID string, instanceID string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ConfigUpdateResponse, error) ConfigUpdate(ctx context.Context, projectID string, instanceID string, body ConfigUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*ConfigUpdateResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type ConfigListResponse ¶
type ConfigListResponse struct { Body []byte HTTPResponse *http.Response JSON200 *LogsConfigResponse JSON403 *PermissionDenied Error error // Aggregated error }
func (ConfigListResponse) Status ¶
func (r ConfigListResponse) Status() string
Status returns HTTPResponse.Status
func (ConfigListResponse) StatusCode ¶
func (r ConfigListResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ConfigUpdateJSONBody ¶
type ConfigUpdateJSONBody struct { // Retention How long to keep the logs // `Additional Validators:` // * Should be a valid time string // * Should not be longer than 30 days Retention string `json:"retention"` }
ConfigUpdateJSONBody defines parameters for ConfigUpdate.
type ConfigUpdateJSONRequestBody ¶
type ConfigUpdateJSONRequestBody ConfigUpdateJSONBody
ConfigUpdateJSONRequestBody defines body for ConfigUpdate for application/json ContentType.
type ConfigUpdateResponse ¶
type ConfigUpdateResponse struct { Body []byte HTTPResponse *http.Response JSON202 *Message JSON400 *Error JSON403 *PermissionDenied Error error // Aggregated error }
func (ConfigUpdateResponse) Status ¶
func (r ConfigUpdateResponse) Status() string
Status returns HTTPResponse.Status
func (ConfigUpdateResponse) StatusCode ¶
func (r ConfigUpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type CreateJSONBody ¶
type CreateJSONBody struct { // Interval How often rules in the group are evaluated. // `Additional Validators:` // * must be a valid time string // * should be >=60s Interval *string `json:"interval,omitempty"` // Name The name of the group. Must be unique. // `Additional Validators:` // * is the identifier and so unique // * should only include the characters: a-zA-Z0-9- Name string `json:"name"` // Rules rules for the alert group Rules []struct { // Alert The name of the alert. // `Additional Validators:` // * is the identifier and so unique in the group // * should only include the characters: a-zA-Z0-9- Alert string `json:"alert"` // Annotations map of key:value. Annotations to add to each alert. // `Additional Validators:` // * should not contain more than 5 keys // * each key and value should not be longer than 200 characters Annotations *map[string]interface{} `json:"annotations,omitempty"` // Expr The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts. Expr string `json:"expr"` // For Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. // `Additional Validators:` // * must be a valid time string For *string `json:"for,omitempty"` // Labels map of key:value. Labels to add or overwrite for each alert. // `Additional Validators:` // * should not contain more than 10 keys // * each key and value should not be longer than 200 characters Labels *map[string]interface{} `json:"labels,omitempty"` } `json:"rules"` }
CreateJSONBody defines parameters for Create.
type CreateJSONRequestBody ¶
type CreateJSONRequestBody CreateJSONBody
CreateJSONRequestBody defines body for Create for application/json ContentType.
type CreateResponse ¶
type CreateResponse struct { Body []byte HTTPResponse *http.Response JSON202 *AlertGroupsResponse JSON400 *Error JSON403 *PermissionDenied Error error // Aggregated error }
func (CreateResponse) Status ¶
func (r CreateResponse) Status() string
Status returns HTTPResponse.Status
func (CreateResponse) StatusCode ¶
func (r CreateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteResponse ¶
type DeleteResponse struct { Body []byte HTTPResponse *http.Response JSON202 *AlertGroupsResponse JSON400 *Message JSON403 *PermissionDenied JSON404 *Message Error error // Aggregated error }
func (DeleteResponse) Status ¶
func (r DeleteResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteResponse) StatusCode ¶
func (r DeleteResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type Error ¶
type Error struct { Errors *[]map[string]string `json:"errors,omitempty"` Message string `json:"message"` }
Error defines model for Error.
type GetResponse ¶
type GetResponse struct { Body []byte HTTPResponse *http.Response JSON200 *AlertGroupResponse JSON400 *Message JSON403 *PermissionDenied JSON404 *Message Error error // Aggregated error }
func (GetResponse) StatusCode ¶
func (r GetResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type ListResponse ¶
type ListResponse struct { Body []byte HTTPResponse *http.Response JSON200 *AlertGroupsResponse JSON400 *Error 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 LogsConfig ¶
type LogsConfig struct {
Retention string `json:"retention"`
}
LogsConfig defines model for LogsConfig.
type LogsConfigResponse ¶
type LogsConfigResponse struct { Config LogsConfig `json:"config"` Message string `json:"message"` }
LogsConfigResponse defines model for LogsConfigResponse.
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 ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type UpdateJSONBody ¶
type UpdateJSONBody struct { // Interval How often rules in the group are evaluated. // `Additional Validators:` // * must be a valid time string // * should be >=60s Interval *string `json:"interval,omitempty"` // Rules rules for the alert group Rules []struct { // Alert The name of the alert. // `Additional Validators:` // * is the identifier and so unique in the group // * should only include the characters: a-zA-Z0-9- Alert string `json:"alert"` // Annotations map of key:value. Annotations to add to each alert. // `Additional Validators:` // * should not contain more than 5 keys // * each key and value should not be longer than 200 characters Annotations *map[string]interface{} `json:"annotations,omitempty"` // Expr The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts. Expr string `json:"expr"` // For Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. // `Additional Validators:` // * must be a valid time string For *string `json:"for,omitempty"` // Labels map of key:value. Labels to add or overwrite for each alert. // `Additional Validators:` // * should not contain more than 10 keys // * each key and value should not be longer than 200 characters Labels *map[string]interface{} `json:"labels,omitempty"` } `json:"rules"` }
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 *AlertGroupsResponse JSON400 *Message JSON403 *PermissionDenied JSON404 *Message 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