Documentation ¶
Overview ¶
Package alertrecords 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 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 NewDeleteRecodsRequest(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 NewPartialUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, ...) (*http.Request, error)
- func NewPartialUpdateRequestWithBody(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 AlertRecord
- type AlertRecordResponse
- type AlertRecordsResponse
- type Client
- func (c *Client[K]) CreateRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) CreateRawWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) DeleteRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) DeleteRecodsRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) GetRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) ListRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) PartialUpdateRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) PartialUpdateRawWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) UpdateRaw(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- func (c *Client[K]) UpdateRawWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*http.Response, error)
- type ClientWithResponses
- func (c *ClientWithResponses[K]) Create(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) CreateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) Delete(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*DeleteResponse, error)
- func (c *ClientWithResponses[K]) DeleteRecods(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*DeleteRecodsResponse, error)
- func (c *ClientWithResponses[K]) Get(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*GetResponse, error)
- func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*ListResponse, error)
- func (c *ClientWithResponses[K]) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
- func (c *ClientWithResponses[K]) ParseDeleteRecodsResponse(rsp *http.Response) (*DeleteRecodsResponse, error)
- func (c *ClientWithResponses[K]) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
- func (c *ClientWithResponses[K]) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
- func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
- func (c *ClientWithResponses[K]) ParsePartialUpdateResponse(rsp *http.Response) (*PartialUpdateResponse, error)
- func (c *ClientWithResponses[K]) ParseUpdateResponse(rsp *http.Response) (*UpdateResponse, error)
- func (c *ClientWithResponses[K]) PartialUpdate(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*PartialUpdateResponse, error)
- func (c *ClientWithResponses[K]) PartialUpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*PartialUpdateResponse, error)
- func (c *ClientWithResponses[K]) Update(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*UpdateResponse, error)
- func (c *ClientWithResponses[K]) UpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, ...) (*UpdateResponse, error)
- type ClientWithResponsesInterface
- type CreateJSONBody
- type CreateJSONRequestBody
- type CreateResponse
- type DeleteParams
- type DeleteRecodsResponse
- type DeleteResponse
- type Error
- type GetResponse
- type ListResponse
- type Message
- type PartialUpdateJSONBody
- type PartialUpdateJSONRequestBody
- type PartialUpdateResponse
- type PermissionDenied
- type RequestEditorFn
- type UpdateJSONBody
- type UpdateJSONRequestBody
- type UpdateResponse
Constants ¶
const (
BearerAuthScopes = "bearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewCreateRequest ¶
func NewCreateRequest(ctx context.Context, server string, projectID string, instanceID string, groupName 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, groupName string, contentType string, body io.Reader) (*http.Request, error)
NewCreateRequestWithBody generates requests for Create with any type of body
func NewDeleteRecodsRequest ¶
func NewDeleteRecodsRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string, alertRecord string) (*http.Request, error)
NewDeleteRecodsRequest generates requests for DeleteRecods
func NewDeleteRequest ¶
func NewDeleteRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string, params *DeleteParams) (*http.Request, error)
NewDeleteRequest generates requests for Delete
func NewGetRequest ¶
func NewGetRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string, alertRecord string) (*http.Request, error)
NewGetRequest generates requests for Get
func NewListRequest ¶
func NewListRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string) (*http.Request, error)
NewListRequest generates requests for List
func NewPartialUpdateRequest ¶
func NewPartialUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string, body PartialUpdateJSONRequestBody) (*http.Request, error)
NewPartialUpdateRequest calls the generic PartialUpdate builder with application/json body
func NewPartialUpdateRequestWithBody ¶
func NewPartialUpdateRequestWithBody(ctx context.Context, server string, projectID string, instanceID string, groupName string, contentType string, body io.Reader) (*http.Request, error)
NewPartialUpdateRequestWithBody generates requests for PartialUpdate with any type of body
func NewUpdateRequest ¶
func NewUpdateRequest(ctx context.Context, server string, projectID string, instanceID string, groupName string, alertRecord 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, groupName string, alertRecord string, contentType string, body io.Reader) (*http.Request, error)
NewUpdateRequestWithBody generates requests for Update with any type of body
Types ¶
type AlertRecord ¶
type AlertRecord struct { Expr string `json:"expr"` Labels *map[string]string `json:"labels,omitempty"` Record string `json:"record"` }
AlertRecord defines model for AlertRecord.
type AlertRecordResponse ¶
type AlertRecordResponse struct { Data AlertRecord `json:"data"` Message string `json:"message"` }
AlertRecordResponse defines model for AlertRecordResponse.
type AlertRecordsResponse ¶
type AlertRecordsResponse struct { Data []AlertRecord `json:"data"` Message string `json:"message"` }
AlertRecordsResponse defines model for AlertRecordsResponse.
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]) CreateRawWithBody ¶
func (*Client[K]) DeleteRecodsRaw ¶
func (*Client[K]) PartialUpdateRaw ¶
func (*Client[K]) PartialUpdateRawWithBody ¶
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]) Create ¶
func (c *ClientWithResponses[K]) Create(ctx context.Context, projectID string, instanceID string, groupName string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error)
func (*ClientWithResponses[K]) CreateWithBody ¶
func (c *ClientWithResponses[K]) CreateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error)
CreateWithBody request with arbitrary body returning *CreateResponse
func (*ClientWithResponses[K]) Delete ¶
func (c *ClientWithResponses[K]) Delete(ctx context.Context, projectID string, instanceID string, groupName string, params *DeleteParams, reqEditors ...RequestEditorFn) (*DeleteResponse, error)
Delete request returning *DeleteResponse
func (*ClientWithResponses[K]) DeleteRecods ¶
func (c *ClientWithResponses[K]) DeleteRecods(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, reqEditors ...RequestEditorFn) (*DeleteRecodsResponse, error)
DeleteRecods request returning *DeleteRecodsResponse
func (*ClientWithResponses[K]) Get ¶
func (c *ClientWithResponses[K]) Get(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, reqEditors ...RequestEditorFn) (*GetResponse, error)
Get request returning *GetResponse
func (*ClientWithResponses[K]) List ¶
func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, instanceID string, groupName string, reqEditors ...RequestEditorFn) (*ListResponse, error)
List request returning *ListResponse
func (*ClientWithResponses[K]) ParseCreateResponse ¶
func (c *ClientWithResponses[K]) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)
ParseCreateResponse parses an HTTP response from a Create call
func (*ClientWithResponses[K]) ParseDeleteRecodsResponse ¶
func (c *ClientWithResponses[K]) ParseDeleteRecodsResponse(rsp *http.Response) (*DeleteRecodsResponse, error)
ParseDeleteRecodsResponse parses an HTTP response from a DeleteRecods call
func (*ClientWithResponses[K]) ParseDeleteResponse ¶
func (c *ClientWithResponses[K]) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)
ParseDeleteResponse parses an HTTP response from a Delete call
func (*ClientWithResponses[K]) ParseGetResponse ¶
func (c *ClientWithResponses[K]) ParseGetResponse(rsp *http.Response) (*GetResponse, error)
ParseGetResponse parses an HTTP response from a Get call
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]) ParsePartialUpdateResponse ¶
func (c *ClientWithResponses[K]) ParsePartialUpdateResponse(rsp *http.Response) (*PartialUpdateResponse, error)
ParsePartialUpdateResponse parses an HTTP response from a PartialUpdate 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]) PartialUpdate ¶
func (c *ClientWithResponses[K]) PartialUpdate(ctx context.Context, projectID string, instanceID string, groupName string, body PartialUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*PartialUpdateResponse, error)
func (*ClientWithResponses[K]) PartialUpdateWithBody ¶
func (c *ClientWithResponses[K]) PartialUpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PartialUpdateResponse, error)
PartialUpdateWithBody request with arbitrary body returning *PartialUpdateResponse
func (*ClientWithResponses[K]) Update ¶
func (c *ClientWithResponses[K]) Update(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error)
func (*ClientWithResponses[K]) UpdateWithBody ¶
func (c *ClientWithResponses[K]) UpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord 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 { // Delete request Delete(ctx context.Context, projectID string, instanceID string, groupName string, params *DeleteParams, reqEditors ...RequestEditorFn) (*DeleteResponse, error) // List request List(ctx context.Context, projectID string, instanceID string, groupName string, reqEditors ...RequestEditorFn) (*ListResponse, error) // PartialUpdate request with any body PartialUpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PartialUpdateResponse, error) PartialUpdate(ctx context.Context, projectID string, instanceID string, groupName string, body PartialUpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*PartialUpdateResponse, error) // Create request with any body CreateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateResponse, error) Create(ctx context.Context, projectID string, instanceID string, groupName string, body CreateJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateResponse, error) // DeleteRecods request DeleteRecods(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, reqEditors ...RequestEditorFn) (*DeleteRecodsResponse, error) // Get request Get(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, reqEditors ...RequestEditorFn) (*GetResponse, error) // Update request with any body UpdateWithBody(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateResponse, error) Update(ctx context.Context, projectID string, instanceID string, groupName string, alertRecord string, body UpdateJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateJSONBody ¶
type CreateJSONBody struct { // 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"` // 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"` // Record The name of the record. // `Additional Validators:` // * is the identifier and so unique in the group Record string `json:"record"` }
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 *AlertRecordsResponse 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 DeleteParams ¶
type DeleteParams struct { // AlertRecord Name of the records that should be deleted AlertRecord []string `form:"alertRecord" json:"alertRecord"` }
DeleteParams defines parameters for Delete.
type DeleteRecodsResponse ¶
type DeleteRecodsResponse struct { Body []byte HTTPResponse *http.Response JSON202 *AlertRecordsResponse JSON403 *PermissionDenied JSON404 *Message Error error // Aggregated error }
func (DeleteRecodsResponse) Status ¶
func (r DeleteRecodsResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteRecodsResponse) StatusCode ¶
func (r DeleteRecodsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteResponse ¶
type DeleteResponse struct { Body []byte HTTPResponse *http.Response JSON202 *AlertRecordsResponse JSON403 *PermissionDenied 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 *AlertRecordResponse JSON400 *Error 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 *AlertRecordsResponse 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 PartialUpdateJSONBody ¶
type PartialUpdateJSONBody = []struct { // 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"` // 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"` // Record The name of the record. // `Additional Validators:` // * is the identifier and so unique in the group Record string `json:"record"` }
PartialUpdateJSONBody defines parameters for PartialUpdate.
type PartialUpdateJSONRequestBody ¶
type PartialUpdateJSONRequestBody = PartialUpdateJSONBody
PartialUpdateJSONRequestBody defines body for PartialUpdate for application/json ContentType.
type PartialUpdateResponse ¶
type PartialUpdateResponse struct { Body []byte HTTPResponse *http.Response JSON202 *AlertRecordsResponse JSON400 *Error JSON403 *PermissionDenied Error error // Aggregated error }
func (PartialUpdateResponse) Status ¶
func (r PartialUpdateResponse) Status() string
Status returns HTTPResponse.Status
func (PartialUpdateResponse) StatusCode ¶
func (r PartialUpdateResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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 { // 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"` // Labels map of key:value. Labels to add or overwrite for each alert. // `Additional Validators:` // * should not contain more than 5 keys // * each key and value should not be longer than 200 characters Labels *map[string]interface{} `json:"labels,omitempty"` }
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 *AlertRecordsResponse JSON400 *Error 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