Documentation
¶
Index ¶
- func CacheExpires(r *http.Response) time.Time
- func IsNil(i interface{}) bool
- func NewConfiguration() *config.Configuration
- func ParameterValueToString(obj interface{}, key string) string
- func PtrBool(v bool) *bool
- func PtrFloat32(v float32) *float32
- func PtrFloat64(v float64) *float64
- func PtrInt(v int) *int
- func PtrInt32(v int32) *int32
- func PtrInt64(v int64) *int64
- func PtrString(v string) *string
- func PtrTime(v time.Time) *time.Time
- type APIClient
- func (a *APIClient) CreateAlertConfigReceiver(ctx context.Context, instanceId string, projectId string) ApiCreateAlertConfigReceiverRequest
- func (a *APIClient) CreateAlertConfigReceiverExecute(ctx context.Context, instanceId string, projectId string) (*AlertConfigReceiversResponse, error)
- func (a *APIClient) CreateAlertConfigRoute(ctx context.Context, instanceId string, projectId string) ApiCreateAlertConfigRouteRequest
- func (a *APIClient) CreateAlertConfigRouteExecute(ctx context.Context, instanceId string, projectId string) (*AlertConfigRouteResponse, error)
- func (a *APIClient) CreateCredentials(ctx context.Context, instanceId string, projectId string) ApiCreateCredentialsRequest
- func (a *APIClient) CreateCredentialsExecute(ctx context.Context, instanceId string, projectId string) (*CreateCredentialsResponse, error)
- func (a *APIClient) CreateInstance(ctx context.Context, projectId string) ApiCreateInstanceRequest
- func (a *APIClient) CreateInstanceExecute(ctx context.Context, projectId string) (*CreateInstanceResponse, error)
- func (a *APIClient) CreateScrapeConfig(ctx context.Context, instanceId string, projectId string) ApiCreateScrapeConfigRequest
- func (a *APIClient) CreateScrapeConfigExecute(ctx context.Context, instanceId string, projectId string) (*ScrapeConfigsResponse, error)
- func (a *APIClient) DeleteAlertConfigReceiver(ctx context.Context, instanceId string, projectId string, receiver string) ApiDeleteAlertConfigReceiverRequest
- func (a *APIClient) DeleteAlertConfigReceiverExecute(ctx context.Context, instanceId string, projectId string, receiver string) (*AlertConfigReceiversResponse, error)
- func (a *APIClient) DeleteAlertConfigRoute(ctx context.Context, instanceId string, projectId string, receiver string) ApiDeleteAlertConfigRouteRequest
- func (a *APIClient) DeleteAlertConfigRouteExecute(ctx context.Context, instanceId string, projectId string, receiver string) (*AlertConfigRouteResponse, error)
- func (a *APIClient) DeleteCredentials(ctx context.Context, instanceId string, projectId string, username string) ApiDeleteCredentialsRequest
- func (a *APIClient) DeleteCredentialsExecute(ctx context.Context, instanceId string, projectId string, username string) (*Message, error)
- func (a *APIClient) DeleteCredentialsRemoteWriteConfig(ctx context.Context, instanceId string, projectId string, username string) ApiDeleteCredentialsRemoteWriteConfigRequest
- func (a *APIClient) DeleteCredentialsRemoteWriteConfigExecute(ctx context.Context, instanceId string, projectId string, username string) (*CredentialsRemoteWriteDeleteResponse, error)
- func (a *APIClient) DeleteInstance(ctx context.Context, instanceId string, projectId string) ApiDeleteInstanceRequest
- func (a *APIClient) DeleteInstanceExecute(ctx context.Context, instanceId string, projectId string) (*InstanceResponse, error)
- func (a *APIClient) DeleteScrapeConfig(ctx context.Context, instanceId string, jobName string, projectId string) ApiDeleteScrapeConfigRequest
- func (a *APIClient) DeleteScrapeConfigExecute(ctx context.Context, instanceId string, jobName string, projectId string) (*DeleteScrapeConfigResponse, error)
- func (a *APIClient) GetAlertConfigReceiver(ctx context.Context, instanceId string, projectId string, receiver string) ApiGetAlertConfigReceiverRequest
- func (a *APIClient) GetAlertConfigReceiverExecute(ctx context.Context, instanceId string, projectId string, receiver string) (*Receiver, error)
- func (a *APIClient) GetAlertConfigRoute(ctx context.Context, instanceId string, projectId string, receiver string) ApiGetAlertConfigRouteRequest
- func (a *APIClient) GetAlertConfigRouteExecute(ctx context.Context, instanceId string, projectId string, receiver string) (*AlertConfigRouteResponse, error)
- func (a *APIClient) GetAlertConfigs(ctx context.Context, instanceId string, projectId string) ApiGetAlertConfigsRequest
- func (a *APIClient) GetAlertConfigsExecute(ctx context.Context, instanceId string, projectId string) (*GetAlertConfigsResponse, error)
- func (c *APIClient) GetConfig() *config.Configuration
- func (a *APIClient) GetCredentials(ctx context.Context, instanceId string, projectId string, username string) ApiGetCredentialsRequest
- func (a *APIClient) GetCredentialsExecute(ctx context.Context, instanceId string, projectId string, username string) (*GetCredentialsResponse, error)
- func (a *APIClient) GetCredentialsRemoteWriteConfig(ctx context.Context, instanceId string, projectId string, username string) ApiGetCredentialsRemoteWriteConfigRequest
- func (a *APIClient) GetCredentialsRemoteWriteConfigExecute(ctx context.Context, instanceId string, projectId string, username string) (*CredentialsRemoteWriteConfig, error)
- func (a *APIClient) GetGrafanaConfigs(ctx context.Context, instanceId string, projectId string) ApiGetGrafanaConfigsRequest
- func (a *APIClient) GetGrafanaConfigsExecute(ctx context.Context, instanceId string, projectId string) (*GrafanaConfigs, error)
- func (a *APIClient) GetInstance(ctx context.Context, instanceId string, projectId string) ApiGetInstanceRequest
- func (a *APIClient) GetInstanceExecute(ctx context.Context, instanceId string, projectId string) (*GetInstanceResponse, error)
- func (a *APIClient) GetMetricsStorageRetention(ctx context.Context, instanceId string, projectId string) ApiGetMetricsStorageRetentionRequest
- func (a *APIClient) GetMetricsStorageRetentionExecute(ctx context.Context, instanceId string, projectId string) (*GetMetricsStorageRetentionResponse, error)
- func (a *APIClient) GetScrapeConfig(ctx context.Context, instanceId string, jobName string, projectId string) ApiGetScrapeConfigRequest
- func (a *APIClient) GetScrapeConfigExecute(ctx context.Context, instanceId string, jobName string, projectId string) (*GetScrapeConfigResponse, error)
- func (a *APIClient) ListACL(ctx context.Context, instanceId string, projectId string) ApiListACLRequest
- func (a *APIClient) ListACLExecute(ctx context.Context, instanceId string, projectId string) (*ListACLResponse, error)
- func (a *APIClient) ListAlertConfigReceivers(ctx context.Context, instanceId string, projectId string) ApiListAlertConfigReceiversRequest
- func (a *APIClient) ListAlertConfigReceiversExecute(ctx context.Context, instanceId string, projectId string) (*AlertConfigReceiversResponse, error)
- func (a *APIClient) ListAlertConfigRoutes(ctx context.Context, instanceId string, projectId string) ApiListAlertConfigRoutesRequest
- func (a *APIClient) ListAlertConfigRoutesExecute(ctx context.Context, instanceId string, projectId string) (*AlertConfigRouteResponse, error)
- func (a *APIClient) ListCredentials(ctx context.Context, instanceId string, projectId string) ApiListCredentialsRequest
- func (a *APIClient) ListCredentialsExecute(ctx context.Context, instanceId string, projectId string) (*ListCredentialsResponse, error)
- func (a *APIClient) ListInstances(ctx context.Context, projectId string) ApiListInstancesRequest
- func (a *APIClient) ListInstancesExecute(ctx context.Context, projectId string) (*ListInstancesResponse, error)
- func (a *APIClient) ListPlans(ctx context.Context, projectId string) ApiListPlansRequest
- func (a *APIClient) ListPlansExecute(ctx context.Context, projectId string) (*PlansResponse, error)
- func (a *APIClient) ListScrapeConfigs(ctx context.Context, instanceId string, projectId string) ApiListScrapeConfigsRequest
- func (a *APIClient) ListScrapeConfigsExecute(ctx context.Context, instanceId string, projectId string) (*ListScrapeConfigsResponse, error)
- func (a *APIClient) UpdateACL(ctx context.Context, instanceId string, projectId string) ApiUpdateACLRequest
- func (a *APIClient) UpdateACLExecute(ctx context.Context, instanceId string, projectId string) (*Message, error)
- func (a *APIClient) UpdateAlertConfigReceiver(ctx context.Context, instanceId string, projectId string, receiver string) ApiUpdateAlertConfigReceiverRequest
- func (a *APIClient) UpdateAlertConfigReceiverExecute(ctx context.Context, instanceId string, projectId string, receiver string) (*AlertConfigReceiversResponse, error)
- func (a *APIClient) UpdateAlertConfigRoute(ctx context.Context, instanceId string, projectId string, receiver string) ApiUpdateAlertConfigRouteRequest
- func (a *APIClient) UpdateAlertConfigRouteExecute(ctx context.Context, instanceId string, projectId string, receiver string) (*AlertConfigRouteResponse, error)
- func (a *APIClient) UpdateAlertConfigs(ctx context.Context, instanceId string, projectId string) ApiUpdateAlertConfigsRequest
- func (a *APIClient) UpdateAlertConfigsExecute(ctx context.Context, instanceId string, projectId string) (*UpdateAlertConfigsResponse, error)
- func (a *APIClient) UpdateCredentialsRemoteWriteConfig(ctx context.Context, instanceId string, projectId string, username string) ApiUpdateCredentialsRemoteWriteConfigRequest
- func (a *APIClient) UpdateCredentialsRemoteWriteConfigExecute(ctx context.Context, instanceId string, projectId string, username string) (*CredentialsRemoteWriteConfig, error)
- func (a *APIClient) UpdateGrafanaConfigs(ctx context.Context, instanceId string, projectId string) ApiUpdateGrafanaConfigsRequest
- func (a *APIClient) UpdateGrafanaConfigsExecute(ctx context.Context, instanceId string, projectId string) (*Message, error)
- func (a *APIClient) UpdateInstance(ctx context.Context, instanceId string, projectId string) ApiUpdateInstanceRequest
- func (a *APIClient) UpdateInstanceExecute(ctx context.Context, instanceId string, projectId string) (*InstanceResponse, error)
- func (a *APIClient) UpdateMetricsStorageRetention(ctx context.Context, instanceId string, projectId string) ApiUpdateMetricsStorageRetentionRequest
- func (a *APIClient) UpdateMetricsStorageRetentionExecute(ctx context.Context, instanceId string, projectId string) (*Message, error)
- func (a *APIClient) UpdateScrapeConfig(ctx context.Context, instanceId string, jobName string, projectId string) ApiUpdateScrapeConfigRequest
- func (a *APIClient) UpdateScrapeConfigExecute(ctx context.Context, instanceId string, jobName string, projectId string) (*ScrapeConfigsResponse, error)
- type Alert
- type AlertConfigReceiversResponse
- type AlertConfigRouteResponse
- type ApiCreateAlertConfigReceiverRequest
- type ApiCreateAlertConfigRouteRequest
- type ApiCreateCredentialsRequest
- type ApiCreateInstanceRequest
- type ApiCreateScrapeConfigRequest
- type ApiDeleteAlertConfigReceiverRequest
- type ApiDeleteAlertConfigRouteRequest
- type ApiDeleteCredentialsRemoteWriteConfigRequest
- type ApiDeleteCredentialsRequest
- type ApiDeleteInstanceRequest
- type ApiDeleteScrapeConfigRequest
- type ApiGetAlertConfigReceiverRequest
- type ApiGetAlertConfigRouteRequest
- type ApiGetAlertConfigsRequest
- type ApiGetCredentialsRemoteWriteConfigRequest
- type ApiGetCredentialsRequest
- type ApiGetGrafanaConfigsRequest
- type ApiGetInstanceRequest
- type ApiGetMetricsStorageRetentionRequest
- type ApiGetScrapeConfigRequest
- type ApiListACLRequest
- type ApiListAlertConfigReceiversRequest
- type ApiListAlertConfigRoutesRequest
- type ApiListCredentialsRequest
- type ApiListInstancesRequest
- type ApiListPlansRequest
- type ApiListScrapeConfigsRequest
- type ApiUpdateACLRequest
- type ApiUpdateAlertConfigReceiverRequest
- type ApiUpdateAlertConfigRouteRequest
- type ApiUpdateAlertConfigsRequest
- type ApiUpdateCredentialsRemoteWriteConfigRequest
- type ApiUpdateGrafanaConfigsRequest
- type ApiUpdateInstanceRequest
- type ApiUpdateMetricsStorageRetentionRequest
- type ApiUpdateScrapeConfigRequest
- type BasicAuth
- type CreateAlertConfigReceiverPayload
- type CreateAlertConfigReceiverPayloadEmailConfigsInner
- type CreateAlertConfigReceiverPayloadOpsgenieConfigsInner
- type CreateAlertConfigReceiverPayloadWebHookConfigsInner
- type CreateAlertConfigRoutePayload
- type CreateAlertConfigRoutePayloadRoutesInner
- type CreateCredentialsResponse
- type CreateInstancePayload
- type CreateInstanceResponse
- type CreateScrapeConfigPayload
- type CreateScrapeConfigPayloadBasicAuth
- type CreateScrapeConfigPayloadHttpSdConfigsInner
- type CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2
- type CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig
- type CreateScrapeConfigPayloadMetricsRelabelConfigsInner
- type CreateScrapeConfigPayloadStaticConfigsInner
- type Credentials
- type CredentialsRemoteWriteConfig
- type CredentialsRemoteWriteDeleteResponse
- type DefaultApiService
- type DeleteScrapeConfigResponse
- type EmailConfig
- type Error
- type GetAlertConfigsResponse
- type GetCredentialsResponse
- type GetInstanceResponse
- type GetMetricsStorageRetentionResponse
- type GetScrapeConfigResponse
- type Global
- type GrafanaConfigs
- type GrafanaOauth
- type HTTPServiceSD
- type InhibitRules
- type Instance
- type InstanceResponse
- type InstanceSensitiveData
- type Job
- type ListACLResponse
- type ListCredentialsResponse
- type ListInstancesResponse
- type ListScrapeConfigsResponse
- type MappedNullable
- type Message
- type MetricsRelabelConfig
- type NullableBool
- type NullableFloat32
- type NullableFloat64
- type NullableInt
- type NullableInt32
- type NullableInt64
- type NullableString
- type NullableTime
- type OAuth2
- type OpsgenieConfig
- type PermissionDenied
- type Plan
- type PlanModel
- type PlansResponse
- type ProjectInstanceFull
- type Receiver
- type Receivers
- type Route
- type RouteSerializer
- type ScrapeConfigsResponse
- type ServiceKeysList
- type StaticConfigs
- type TLSConfig
- type UpdateACLPayload
- type UpdateAlertConfigReceiverPayload
- type UpdateAlertConfigRoutePayload
- type UpdateAlertConfigsPayload
- type UpdateAlertConfigsPayloadGlobal
- type UpdateAlertConfigsPayloadInhibitRules
- type UpdateAlertConfigsPayloadReceiversInner
- type UpdateAlertConfigsPayloadRoute
- type UpdateAlertConfigsResponse
- type UpdateCredentialsRemoteWriteConfigPayload
- type UpdateGrafanaConfigsPayload
- type UpdateGrafanaConfigsPayloadGenericOauth
- type UpdateInstancePayload
- type UpdateMetricsStorageRetentionPayload
- type UpdateScrapeConfigPayload
- type UpdateScrapeConfigPayloadStaticConfigsInner
- type WebHook
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CacheExpires ¶
CacheExpires helper function to determine remaining time before repeating a request.
func NewConfiguration ¶
func NewConfiguration() *config.Configuration
NewConfiguration returns a new Configuration object
func ParameterValueToString ¶
func PtrFloat32 ¶
PtrFloat32 is a helper routine that returns a pointer to given float value.
func PtrFloat64 ¶
PtrFloat64 is a helper routine that returns a pointer to given float value.
Types ¶
type APIClient ¶
type APIClient struct {
// contains filtered or unexported fields
}
APIClient manages communication with the STACKIT Argus API API v1.1.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(opts ...config.ConfigurationOption) (*APIClient, error)
NewAPIClient creates a new API client. Optionally receives configuration options
func (*APIClient) CreateAlertConfigReceiver ¶
func (a *APIClient) CreateAlertConfigReceiver(ctx context.Context, instanceId string, projectId string) ApiCreateAlertConfigReceiverRequest
CreateAlertConfigReceiver: Method for CreateAlertConfigReceiver
Create alert config receiver.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiCreateAlertConfigReceiverRequest
func (*APIClient) CreateAlertConfigReceiverExecute ¶
func (*APIClient) CreateAlertConfigRoute ¶
func (a *APIClient) CreateAlertConfigRoute(ctx context.Context, instanceId string, projectId string) ApiCreateAlertConfigRouteRequest
CreateAlertConfigRoute: Method for CreateAlertConfigRoute
Create alert config route in routes of route.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiCreateAlertConfigRouteRequest
func (*APIClient) CreateAlertConfigRouteExecute ¶
func (*APIClient) CreateCredentials ¶
func (a *APIClient) CreateCredentials(ctx context.Context, instanceId string, projectId string) ApiCreateCredentialsRequest
CreateCredentials: Method for CreateCredentials
Create technical user credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiCreateCredentialsRequest
func (*APIClient) CreateCredentialsExecute ¶
func (*APIClient) CreateInstance ¶
func (a *APIClient) CreateInstance(ctx context.Context, projectId string) ApiCreateInstanceRequest
CreateInstance: Method for CreateInstance
Create new instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiCreateInstanceRequest
func (*APIClient) CreateInstanceExecute ¶
func (*APIClient) CreateScrapeConfig ¶
func (a *APIClient) CreateScrapeConfig(ctx context.Context, instanceId string, projectId string) ApiCreateScrapeConfigRequest
CreateScrapeConfig: Method for CreateScrapeConfig
Create scrape config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiCreateScrapeConfigRequest
func (*APIClient) CreateScrapeConfigExecute ¶
func (*APIClient) DeleteAlertConfigReceiver ¶
func (a *APIClient) DeleteAlertConfigReceiver(ctx context.Context, instanceId string, projectId string, receiver string) ApiDeleteAlertConfigReceiverRequest
DeleteAlertConfigReceiver: Method for DeleteAlertConfigReceiver
Delete alert config receiver.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param receiver @return ApiDeleteAlertConfigReceiverRequest
func (*APIClient) DeleteAlertConfigReceiverExecute ¶
func (*APIClient) DeleteAlertConfigRoute ¶
func (a *APIClient) DeleteAlertConfigRoute(ctx context.Context, instanceId string, projectId string, receiver string) ApiDeleteAlertConfigRouteRequest
DeleteAlertConfigRoute: Method for DeleteAlertConfigRoute
Delete alert receiver for route.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param receiver @return ApiDeleteAlertConfigRouteRequest
func (*APIClient) DeleteAlertConfigRouteExecute ¶
func (*APIClient) DeleteCredentials ¶
func (a *APIClient) DeleteCredentials(ctx context.Context, instanceId string, projectId string, username string) ApiDeleteCredentialsRequest
DeleteCredentials: Method for DeleteCredentials
Delete technical credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param username @return ApiDeleteCredentialsRequest
func (*APIClient) DeleteCredentialsExecute ¶
func (*APIClient) DeleteCredentialsRemoteWriteConfig ¶
func (a *APIClient) DeleteCredentialsRemoteWriteConfig(ctx context.Context, instanceId string, projectId string, username string) ApiDeleteCredentialsRemoteWriteConfigRequest
DeleteCredentialsRemoteWriteConfig: Method for DeleteCredentialsRemoteWriteConfig
Delete remote write config for credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param username @return ApiDeleteCredentialsRemoteWriteConfigRequest
func (*APIClient) DeleteCredentialsRemoteWriteConfigExecute ¶
func (*APIClient) DeleteInstance ¶
func (a *APIClient) DeleteInstance(ctx context.Context, instanceId string, projectId string) ApiDeleteInstanceRequest
DeleteInstance: Method for DeleteInstance
Delete instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiDeleteInstanceRequest
func (*APIClient) DeleteInstanceExecute ¶
func (*APIClient) DeleteScrapeConfig ¶
func (a *APIClient) DeleteScrapeConfig(ctx context.Context, instanceId string, jobName string, projectId string) ApiDeleteScrapeConfigRequest
DeleteScrapeConfig: Method for DeleteScrapeConfig
Delete scrape config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param jobName @param projectId @return ApiDeleteScrapeConfigRequest
func (*APIClient) DeleteScrapeConfigExecute ¶
func (*APIClient) GetAlertConfigReceiver ¶
func (a *APIClient) GetAlertConfigReceiver(ctx context.Context, instanceId string, projectId string, receiver string) ApiGetAlertConfigReceiverRequest
GetAlertConfigReceiver: Method for GetAlertConfigReceiver
Get alert config receivers.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param receiver @return ApiGetAlertConfigReceiverRequest
func (*APIClient) GetAlertConfigReceiverExecute ¶
func (*APIClient) GetAlertConfigRoute ¶
func (a *APIClient) GetAlertConfigRoute(ctx context.Context, instanceId string, projectId string, receiver string) ApiGetAlertConfigRouteRequest
GetAlertConfigRoute: Method for GetAlertConfigRoute
Get alert receiver for route.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param receiver @return ApiGetAlertConfigRouteRequest
func (*APIClient) GetAlertConfigRouteExecute ¶
func (*APIClient) GetAlertConfigs ¶
func (a *APIClient) GetAlertConfigs(ctx context.Context, instanceId string, projectId string) ApiGetAlertConfigsRequest
GetAlertConfigs: Method for GetAlertConfigs
Get alert config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiGetAlertConfigsRequest
func (*APIClient) GetAlertConfigsExecute ¶
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *config.Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
func (*APIClient) GetCredentials ¶
func (a *APIClient) GetCredentials(ctx context.Context, instanceId string, projectId string, username string) ApiGetCredentialsRequest
GetCredentials: Method for GetCredentials
Get single technical credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param username @return ApiGetCredentialsRequest
func (*APIClient) GetCredentialsExecute ¶
func (*APIClient) GetCredentialsRemoteWriteConfig ¶
func (a *APIClient) GetCredentialsRemoteWriteConfig(ctx context.Context, instanceId string, projectId string, username string) ApiGetCredentialsRemoteWriteConfigRequest
GetCredentialsRemoteWriteConfig: Method for GetCredentialsRemoteWriteConfig
Get remote write config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param username @return ApiGetCredentialsRemoteWriteConfigRequest
func (*APIClient) GetCredentialsRemoteWriteConfigExecute ¶
func (*APIClient) GetGrafanaConfigs ¶
func (a *APIClient) GetGrafanaConfigs(ctx context.Context, instanceId string, projectId string) ApiGetGrafanaConfigsRequest
GetGrafanaConfigs: Method for GetGrafanaConfigs
Get grafana config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiGetGrafanaConfigsRequest
func (*APIClient) GetGrafanaConfigsExecute ¶
func (*APIClient) GetInstance ¶
func (a *APIClient) GetInstance(ctx context.Context, instanceId string, projectId string) ApiGetInstanceRequest
GetInstance: Method for GetInstance
Get instance information.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiGetInstanceRequest
func (*APIClient) GetInstanceExecute ¶
func (*APIClient) GetMetricsStorageRetention ¶
func (a *APIClient) GetMetricsStorageRetention(ctx context.Context, instanceId string, projectId string) ApiGetMetricsStorageRetentionRequest
GetMetricsStorageRetention: Method for GetMetricsStorageRetention
Get metric storage retention time.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiGetMetricsStorageRetentionRequest
func (*APIClient) GetMetricsStorageRetentionExecute ¶
func (*APIClient) GetScrapeConfig ¶
func (a *APIClient) GetScrapeConfig(ctx context.Context, instanceId string, jobName string, projectId string) ApiGetScrapeConfigRequest
GetScrapeConfig: Method for GetScrapeConfig
Get scrape config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param jobName @param projectId @return ApiGetScrapeConfigRequest
func (*APIClient) GetScrapeConfigExecute ¶
func (*APIClient) ListACL ¶
func (a *APIClient) ListACL(ctx context.Context, instanceId string, projectId string) ApiListACLRequest
ListACL: Method for ListACL
Get acl for instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiListACLRequest
func (*APIClient) ListACLExecute ¶
func (*APIClient) ListAlertConfigReceivers ¶
func (a *APIClient) ListAlertConfigReceivers(ctx context.Context, instanceId string, projectId string) ApiListAlertConfigReceiversRequest
ListAlertConfigReceivers: Method for ListAlertConfigReceivers
Get alert config receivers.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiListAlertConfigReceiversRequest
func (*APIClient) ListAlertConfigReceiversExecute ¶
func (*APIClient) ListAlertConfigRoutes ¶
func (a *APIClient) ListAlertConfigRoutes(ctx context.Context, instanceId string, projectId string) ApiListAlertConfigRoutesRequest
ListAlertConfigRoutes: Method for ListAlertConfigRoutes
Get alert config route.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiListAlertConfigRoutesRequest
func (*APIClient) ListAlertConfigRoutesExecute ¶
func (*APIClient) ListCredentials ¶
func (a *APIClient) ListCredentials(ctx context.Context, instanceId string, projectId string) ApiListCredentialsRequest
ListCredentials: Method for ListCredentials
Get all technical user credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiListCredentialsRequest
func (*APIClient) ListCredentialsExecute ¶
func (*APIClient) ListInstances ¶
func (a *APIClient) ListInstances(ctx context.Context, projectId string) ApiListInstancesRequest
ListInstances: Method for ListInstances
Get all instances for a project.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiListInstancesRequest
func (*APIClient) ListInstancesExecute ¶
func (*APIClient) ListPlans ¶
func (a *APIClient) ListPlans(ctx context.Context, projectId string) ApiListPlansRequest
ListPlans: Method for ListPlans
Get all plans.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param projectId @return ApiListPlansRequest
func (*APIClient) ListPlansExecute ¶
func (*APIClient) ListScrapeConfigs ¶
func (a *APIClient) ListScrapeConfigs(ctx context.Context, instanceId string, projectId string) ApiListScrapeConfigsRequest
ListScrapeConfigs: Method for ListScrapeConfigs
Get scrape configs.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiListScrapeConfigsRequest
func (*APIClient) ListScrapeConfigsExecute ¶
func (*APIClient) UpdateACL ¶
func (a *APIClient) UpdateACL(ctx context.Context, instanceId string, projectId string) ApiUpdateACLRequest
UpdateACL: Method for UpdateACL
Update acl config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiUpdateACLRequest
func (*APIClient) UpdateACLExecute ¶
func (*APIClient) UpdateAlertConfigReceiver ¶
func (a *APIClient) UpdateAlertConfigReceiver(ctx context.Context, instanceId string, projectId string, receiver string) ApiUpdateAlertConfigReceiverRequest
UpdateAlertConfigReceiver: Method for UpdateAlertConfigReceiver
Update alert config receiver.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param receiver @return ApiUpdateAlertConfigReceiverRequest
func (*APIClient) UpdateAlertConfigReceiverExecute ¶
func (*APIClient) UpdateAlertConfigRoute ¶
func (a *APIClient) UpdateAlertConfigRoute(ctx context.Context, instanceId string, projectId string, receiver string) ApiUpdateAlertConfigRouteRequest
UpdateAlertConfigRoute: Method for UpdateAlertConfigRoute
Update alert receiver for route.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param receiver @return ApiUpdateAlertConfigRouteRequest
func (*APIClient) UpdateAlertConfigRouteExecute ¶
func (*APIClient) UpdateAlertConfigs ¶
func (a *APIClient) UpdateAlertConfigs(ctx context.Context, instanceId string, projectId string) ApiUpdateAlertConfigsRequest
UpdateAlertConfigs: Method for UpdateAlertConfigs
Update alert config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiUpdateAlertConfigsRequest
func (*APIClient) UpdateAlertConfigsExecute ¶
func (*APIClient) UpdateCredentialsRemoteWriteConfig ¶
func (a *APIClient) UpdateCredentialsRemoteWriteConfig(ctx context.Context, instanceId string, projectId string, username string) ApiUpdateCredentialsRemoteWriteConfigRequest
UpdateCredentialsRemoteWriteConfig: Method for UpdateCredentialsRemoteWriteConfig
Update remote write config for credentials.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @param username @return ApiUpdateCredentialsRemoteWriteConfigRequest
func (*APIClient) UpdateCredentialsRemoteWriteConfigExecute ¶
func (*APIClient) UpdateGrafanaConfigs ¶
func (a *APIClient) UpdateGrafanaConfigs(ctx context.Context, instanceId string, projectId string) ApiUpdateGrafanaConfigsRequest
UpdateGrafanaConfigs: Method for UpdateGrafanaConfigs
Update grafana config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiUpdateGrafanaConfigsRequest
func (*APIClient) UpdateGrafanaConfigsExecute ¶
func (*APIClient) UpdateInstance ¶
func (a *APIClient) UpdateInstance(ctx context.Context, instanceId string, projectId string) ApiUpdateInstanceRequest
UpdateInstance: Method for UpdateInstance
Update instance.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiUpdateInstanceRequest
func (*APIClient) UpdateInstanceExecute ¶
func (*APIClient) UpdateMetricsStorageRetention ¶
func (a *APIClient) UpdateMetricsStorageRetention(ctx context.Context, instanceId string, projectId string) ApiUpdateMetricsStorageRetentionRequest
UpdateMetricsStorageRetention: Method for UpdateMetricsStorageRetention
Update metric update retention time.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param projectId @return ApiUpdateMetricsStorageRetentionRequest
func (*APIClient) UpdateMetricsStorageRetentionExecute ¶
func (*APIClient) UpdateScrapeConfig ¶
func (a *APIClient) UpdateScrapeConfig(ctx context.Context, instanceId string, jobName string, projectId string) ApiUpdateScrapeConfigRequest
UpdateScrapeConfig: Method for UpdateScrapeConfig
Update scrape config.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param instanceId @param jobName @param projectId @return ApiUpdateScrapeConfigRequest
func (*APIClient) UpdateScrapeConfigExecute ¶
type Alert ¶
type Alert struct {
Global *Global `json:"global,omitempty"`
InhibitRules *[]InhibitRules `json:"inhibitRules,omitempty"`
// REQUIRED
Receivers *[]Receivers `json:"receivers"`
// REQUIRED
Route *Route `json:"route"`
}
Alert struct for Alert
type AlertConfigReceiversResponse ¶
type AlertConfigReceiversResponse struct {
// REQUIRED
Data *[]Receivers `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
AlertConfigReceiversResponse struct for AlertConfigReceiversResponse
type AlertConfigRouteResponse ¶
type AlertConfigRouteResponse struct {
// REQUIRED
Data *Route `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
AlertConfigRouteResponse struct for AlertConfigRouteResponse
type ApiCreateAlertConfigReceiverRequest ¶
type ApiCreateAlertConfigReceiverRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateAlertConfigReceiverRequest) CreateAlertConfigReceiverPayload ¶
func (r ApiCreateAlertConfigReceiverRequest) CreateAlertConfigReceiverPayload(createAlertConfigReceiverPayload CreateAlertConfigReceiverPayload) ApiCreateAlertConfigReceiverRequest
func (ApiCreateAlertConfigReceiverRequest) Execute ¶
func (r ApiCreateAlertConfigReceiverRequest) Execute() (*AlertConfigReceiversResponse, error)
type ApiCreateAlertConfigRouteRequest ¶
type ApiCreateAlertConfigRouteRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateAlertConfigRouteRequest) CreateAlertConfigRoutePayload ¶
func (r ApiCreateAlertConfigRouteRequest) CreateAlertConfigRoutePayload(createAlertConfigRoutePayload CreateAlertConfigRoutePayload) ApiCreateAlertConfigRouteRequest
func (ApiCreateAlertConfigRouteRequest) Execute ¶
func (r ApiCreateAlertConfigRouteRequest) Execute() (*AlertConfigRouteResponse, error)
type ApiCreateCredentialsRequest ¶
type ApiCreateCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateCredentialsRequest) Execute ¶
func (r ApiCreateCredentialsRequest) Execute() (*CreateCredentialsResponse, error)
type ApiCreateInstanceRequest ¶
type ApiCreateInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateInstanceRequest) CreateInstancePayload ¶
func (r ApiCreateInstanceRequest) CreateInstancePayload(createInstancePayload CreateInstancePayload) ApiCreateInstanceRequest
func (ApiCreateInstanceRequest) Execute ¶
func (r ApiCreateInstanceRequest) Execute() (*CreateInstanceResponse, error)
type ApiCreateScrapeConfigRequest ¶
type ApiCreateScrapeConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiCreateScrapeConfigRequest) CreateScrapeConfigPayload ¶
func (r ApiCreateScrapeConfigRequest) CreateScrapeConfigPayload(createScrapeConfigPayload CreateScrapeConfigPayload) ApiCreateScrapeConfigRequest
func (ApiCreateScrapeConfigRequest) Execute ¶
func (r ApiCreateScrapeConfigRequest) Execute() (*ScrapeConfigsResponse, error)
type ApiDeleteAlertConfigReceiverRequest ¶
type ApiDeleteAlertConfigReceiverRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteAlertConfigReceiverRequest) Execute ¶
func (r ApiDeleteAlertConfigReceiverRequest) Execute() (*AlertConfigReceiversResponse, error)
type ApiDeleteAlertConfigRouteRequest ¶
type ApiDeleteAlertConfigRouteRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteAlertConfigRouteRequest) Execute ¶
func (r ApiDeleteAlertConfigRouteRequest) Execute() (*AlertConfigRouteResponse, error)
type ApiDeleteCredentialsRemoteWriteConfigRequest ¶
type ApiDeleteCredentialsRemoteWriteConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteCredentialsRemoteWriteConfigRequest) Execute ¶
func (r ApiDeleteCredentialsRemoteWriteConfigRequest) Execute() (*CredentialsRemoteWriteDeleteResponse, error)
type ApiDeleteCredentialsRequest ¶
type ApiDeleteCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteCredentialsRequest) Execute ¶
func (r ApiDeleteCredentialsRequest) Execute() (*Message, error)
type ApiDeleteInstanceRequest ¶
type ApiDeleteInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteInstanceRequest) Execute ¶
func (r ApiDeleteInstanceRequest) Execute() (*InstanceResponse, error)
type ApiDeleteScrapeConfigRequest ¶
type ApiDeleteScrapeConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiDeleteScrapeConfigRequest) Execute ¶
func (r ApiDeleteScrapeConfigRequest) Execute() (*DeleteScrapeConfigResponse, error)
type ApiGetAlertConfigReceiverRequest ¶
type ApiGetAlertConfigReceiverRequest struct {
// contains filtered or unexported fields
}
func (ApiGetAlertConfigReceiverRequest) Execute ¶
func (r ApiGetAlertConfigReceiverRequest) Execute() (*Receiver, error)
type ApiGetAlertConfigRouteRequest ¶
type ApiGetAlertConfigRouteRequest struct {
// contains filtered or unexported fields
}
func (ApiGetAlertConfigRouteRequest) Execute ¶
func (r ApiGetAlertConfigRouteRequest) Execute() (*AlertConfigRouteResponse, error)
type ApiGetAlertConfigsRequest ¶
type ApiGetAlertConfigsRequest struct {
// contains filtered or unexported fields
}
func (ApiGetAlertConfigsRequest) Execute ¶
func (r ApiGetAlertConfigsRequest) Execute() (*GetAlertConfigsResponse, error)
type ApiGetCredentialsRemoteWriteConfigRequest ¶
type ApiGetCredentialsRemoteWriteConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiGetCredentialsRemoteWriteConfigRequest) Execute ¶
func (r ApiGetCredentialsRemoteWriteConfigRequest) Execute() (*CredentialsRemoteWriteConfig, error)
type ApiGetCredentialsRequest ¶
type ApiGetCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiGetCredentialsRequest) Execute ¶
func (r ApiGetCredentialsRequest) Execute() (*GetCredentialsResponse, error)
type ApiGetGrafanaConfigsRequest ¶
type ApiGetGrafanaConfigsRequest struct {
// contains filtered or unexported fields
}
func (ApiGetGrafanaConfigsRequest) Execute ¶
func (r ApiGetGrafanaConfigsRequest) Execute() (*GrafanaConfigs, error)
type ApiGetInstanceRequest ¶
type ApiGetInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiGetInstanceRequest) Execute ¶
func (r ApiGetInstanceRequest) Execute() (*GetInstanceResponse, error)
type ApiGetMetricsStorageRetentionRequest ¶
type ApiGetMetricsStorageRetentionRequest struct {
// contains filtered or unexported fields
}
func (ApiGetMetricsStorageRetentionRequest) Execute ¶
func (r ApiGetMetricsStorageRetentionRequest) Execute() (*GetMetricsStorageRetentionResponse, error)
type ApiGetScrapeConfigRequest ¶
type ApiGetScrapeConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiGetScrapeConfigRequest) Execute ¶
func (r ApiGetScrapeConfigRequest) Execute() (*GetScrapeConfigResponse, error)
type ApiListACLRequest ¶
type ApiListACLRequest struct {
// contains filtered or unexported fields
}
func (ApiListACLRequest) Execute ¶
func (r ApiListACLRequest) Execute() (*ListACLResponse, error)
type ApiListAlertConfigReceiversRequest ¶
type ApiListAlertConfigReceiversRequest struct {
// contains filtered or unexported fields
}
func (ApiListAlertConfigReceiversRequest) Execute ¶
func (r ApiListAlertConfigReceiversRequest) Execute() (*AlertConfigReceiversResponse, error)
type ApiListAlertConfigRoutesRequest ¶
type ApiListAlertConfigRoutesRequest struct {
// contains filtered or unexported fields
}
func (ApiListAlertConfigRoutesRequest) Execute ¶
func (r ApiListAlertConfigRoutesRequest) Execute() (*AlertConfigRouteResponse, error)
type ApiListCredentialsRequest ¶
type ApiListCredentialsRequest struct {
// contains filtered or unexported fields
}
func (ApiListCredentialsRequest) Execute ¶
func (r ApiListCredentialsRequest) Execute() (*ListCredentialsResponse, error)
type ApiListInstancesRequest ¶
type ApiListInstancesRequest struct {
// contains filtered or unexported fields
}
func (ApiListInstancesRequest) Execute ¶
func (r ApiListInstancesRequest) Execute() (*ListInstancesResponse, error)
type ApiListPlansRequest ¶
type ApiListPlansRequest struct {
// contains filtered or unexported fields
}
func (ApiListPlansRequest) Execute ¶
func (r ApiListPlansRequest) Execute() (*PlansResponse, error)
type ApiListScrapeConfigsRequest ¶
type ApiListScrapeConfigsRequest struct {
// contains filtered or unexported fields
}
func (ApiListScrapeConfigsRequest) Execute ¶
func (r ApiListScrapeConfigsRequest) Execute() (*ListScrapeConfigsResponse, error)
type ApiUpdateACLRequest ¶
type ApiUpdateACLRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateACLRequest) Execute ¶
func (r ApiUpdateACLRequest) Execute() (*Message, error)
func (ApiUpdateACLRequest) UpdateACLPayload ¶
func (r ApiUpdateACLRequest) UpdateACLPayload(updateACLPayload UpdateACLPayload) ApiUpdateACLRequest
type ApiUpdateAlertConfigReceiverRequest ¶
type ApiUpdateAlertConfigReceiverRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateAlertConfigReceiverRequest) Execute ¶
func (r ApiUpdateAlertConfigReceiverRequest) Execute() (*AlertConfigReceiversResponse, error)
func (ApiUpdateAlertConfigReceiverRequest) UpdateAlertConfigReceiverPayload ¶
func (r ApiUpdateAlertConfigReceiverRequest) UpdateAlertConfigReceiverPayload(updateAlertConfigReceiverPayload UpdateAlertConfigReceiverPayload) ApiUpdateAlertConfigReceiverRequest
type ApiUpdateAlertConfigRouteRequest ¶
type ApiUpdateAlertConfigRouteRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateAlertConfigRouteRequest) Execute ¶
func (r ApiUpdateAlertConfigRouteRequest) Execute() (*AlertConfigRouteResponse, error)
func (ApiUpdateAlertConfigRouteRequest) UpdateAlertConfigRoutePayload ¶
func (r ApiUpdateAlertConfigRouteRequest) UpdateAlertConfigRoutePayload(updateAlertConfigRoutePayload UpdateAlertConfigRoutePayload) ApiUpdateAlertConfigRouteRequest
type ApiUpdateAlertConfigsRequest ¶
type ApiUpdateAlertConfigsRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateAlertConfigsRequest) Execute ¶
func (r ApiUpdateAlertConfigsRequest) Execute() (*UpdateAlertConfigsResponse, error)
func (ApiUpdateAlertConfigsRequest) UpdateAlertConfigsPayload ¶
func (r ApiUpdateAlertConfigsRequest) UpdateAlertConfigsPayload(updateAlertConfigsPayload UpdateAlertConfigsPayload) ApiUpdateAlertConfigsRequest
type ApiUpdateCredentialsRemoteWriteConfigRequest ¶
type ApiUpdateCredentialsRemoteWriteConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateCredentialsRemoteWriteConfigRequest) Execute ¶
func (r ApiUpdateCredentialsRemoteWriteConfigRequest) Execute() (*CredentialsRemoteWriteConfig, error)
func (ApiUpdateCredentialsRemoteWriteConfigRequest) UpdateCredentialsRemoteWriteConfigPayload ¶
func (r ApiUpdateCredentialsRemoteWriteConfigRequest) UpdateCredentialsRemoteWriteConfigPayload(updateCredentialsRemoteWriteConfigPayload UpdateCredentialsRemoteWriteConfigPayload) ApiUpdateCredentialsRemoteWriteConfigRequest
type ApiUpdateGrafanaConfigsRequest ¶
type ApiUpdateGrafanaConfigsRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateGrafanaConfigsRequest) Execute ¶
func (r ApiUpdateGrafanaConfigsRequest) Execute() (*Message, error)
func (ApiUpdateGrafanaConfigsRequest) UpdateGrafanaConfigsPayload ¶
func (r ApiUpdateGrafanaConfigsRequest) UpdateGrafanaConfigsPayload(updateGrafanaConfigsPayload UpdateGrafanaConfigsPayload) ApiUpdateGrafanaConfigsRequest
type ApiUpdateInstanceRequest ¶
type ApiUpdateInstanceRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateInstanceRequest) Execute ¶
func (r ApiUpdateInstanceRequest) Execute() (*InstanceResponse, error)
func (ApiUpdateInstanceRequest) UpdateInstancePayload ¶
func (r ApiUpdateInstanceRequest) UpdateInstancePayload(updateInstancePayload UpdateInstancePayload) ApiUpdateInstanceRequest
type ApiUpdateMetricsStorageRetentionRequest ¶
type ApiUpdateMetricsStorageRetentionRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateMetricsStorageRetentionRequest) Execute ¶
func (r ApiUpdateMetricsStorageRetentionRequest) Execute() (*Message, error)
func (ApiUpdateMetricsStorageRetentionRequest) UpdateMetricsStorageRetentionPayload ¶
func (r ApiUpdateMetricsStorageRetentionRequest) UpdateMetricsStorageRetentionPayload(updateMetricsStorageRetentionPayload UpdateMetricsStorageRetentionPayload) ApiUpdateMetricsStorageRetentionRequest
type ApiUpdateScrapeConfigRequest ¶
type ApiUpdateScrapeConfigRequest struct {
// contains filtered or unexported fields
}
func (ApiUpdateScrapeConfigRequest) Execute ¶
func (r ApiUpdateScrapeConfigRequest) Execute() (*ScrapeConfigsResponse, error)
func (ApiUpdateScrapeConfigRequest) UpdateScrapeConfigPayload ¶
func (r ApiUpdateScrapeConfigRequest) UpdateScrapeConfigPayload(updateScrapeConfigPayload UpdateScrapeConfigPayload) ApiUpdateScrapeConfigRequest
type BasicAuth ¶
type BasicAuth struct {
// REQUIRED
Password *string `json:"password"`
// REQUIRED
Username *string `json:"username"`
}
BasicAuth struct for BasicAuth
type CreateAlertConfigReceiverPayload ¶
type CreateAlertConfigReceiverPayload struct {
// Email configurations
EmailConfigs *[]CreateAlertConfigReceiverPayloadEmailConfigsInner `json:"emailConfigs,omitempty"`
// `Additional Validators:` * must be unique * should only include the characters: a-zA-Z0-9-
// REQUIRED
Name *string `json:"name"`
// Configuration for ops genie.
OpsgenieConfigs *[]CreateAlertConfigReceiverPayloadOpsgenieConfigsInner `json:"opsgenieConfigs,omitempty"`
WebHookConfigs *[]CreateAlertConfigReceiverPayloadWebHookConfigsInner `json:"webHookConfigs,omitempty"`
}
CreateAlertConfigReceiverPayload Receivers
type CreateAlertConfigReceiverPayloadEmailConfigsInner ¶
type CreateAlertConfigReceiverPayloadEmailConfigsInner struct {
// SMTP authentication information. `Additional Validators:` * must be a syntactically valid email address
AuthIdentity *string `json:"authIdentity,omitempty"`
// SMTP authentication information.
AuthPassword *string `json:"authPassword,omitempty"`
// SMTP authentication information.
AuthUsername *string `json:"authUsername,omitempty"`
// The sender address. `Additional Validators:` * must be a syntactically valid email address
From *string `json:"from,omitempty"`
// The SMTP host through which emails are sent. `Additional Validators:` * should only include the characters: a-zA-Z0-9_./@&?:-
Smarthost *string `json:"smarthost,omitempty"`
// The email address to send notifications to. `Additional Validators:` * must be a syntactically valid email address
To *string `json:"to,omitempty"`
}
CreateAlertConfigReceiverPayloadEmailConfigsInner struct for CreateAlertConfigReceiverPayloadEmailConfigsInner
type CreateAlertConfigReceiverPayloadOpsgenieConfigsInner ¶
type CreateAlertConfigReceiverPayloadOpsgenieConfigsInner struct {
// The API key to use when talking to the OpsGenie API. `Additional Validators:` * should only include the characters: a-zA-Z0-9-
ApiKey *string `json:"apiKey,omitempty"`
// The host to send OpsGenie API requests to. `Additional Validators:` * must be a syntactically valid url address
ApiUrl *string `json:"apiUrl,omitempty"`
// Comma separated list of tags attached to the notifications.
Tags *string `json:"tags,omitempty"`
}
CreateAlertConfigReceiverPayloadOpsgenieConfigsInner struct for CreateAlertConfigReceiverPayloadOpsgenieConfigsInner
type CreateAlertConfigReceiverPayloadWebHookConfigsInner ¶
type CreateAlertConfigReceiverPayloadWebHookConfigsInner struct {
// Microsoft Teams webhooks require special handling. If you set this property to true, it is treated as such
MsTeams *bool `json:"msTeams,omitempty"`
// The endpoint to send HTTP POST requests to. `Additional Validators:` * must be a syntactically valid url address
Url *string `json:"url,omitempty"`
}
CreateAlertConfigReceiverPayloadWebHookConfigsInner struct for CreateAlertConfigReceiverPayloadWebHookConfigsInner
type CreateAlertConfigRoutePayload ¶
type CreateAlertConfigRoutePayload struct {
// The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupBy *[]string `json:"groupBy,omitempty"`
// How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.) `Additional Validators:` * must be a valid time format
GroupInterval *string `json:"groupInterval,omitempty"`
// How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) `Additional Validators:` * must be a valid time format
GroupWait *string `json:"groupWait,omitempty"`
// map of key:value. A set of equality matchers an alert has to fulfill to match the node. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters * key and values should only include the characters: a-zA-Z0-9_./@&?:-
Match *map[string]interface{} `json:"match,omitempty"`
// map of key:value. A set of regex-matchers an alert has to fulfill to match the node. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters
MatchRe *map[string]interface{} `json:"matchRe,omitempty"`
// A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics. The syntax of a matcher consists of three tokens: * A valid Prometheus label name. * One of =, !=, =~, or !~. = means equals, != means that the strings are not equal, =~ is used for equality of regex expressions and !~ is used for un-equality of regex expressions. They have the same meaning as known from PromQL selectors. * A UTF-8 string, which may be enclosed in double quotes. Before or after each token, there may be any amount of whitespace. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters
Matchers *[]string `json:"matchers,omitempty"`
// Receiver that should be one item of receivers `Additional Validators:` * must be a in name of receivers
// REQUIRED
Receiver *string `json:"receiver"`
// How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more). `Additional Validators:` * must be a valid time format
RepeatInterval *string `json:"repeatInterval,omitempty"`
// Zero or more child routes.
Routes *[]CreateAlertConfigRoutePayloadRoutesInner `json:"routes,omitempty"`
}
CreateAlertConfigRoutePayload The root node of the routing tree.
type CreateAlertConfigRoutePayloadRoutesInner ¶
type CreateAlertConfigRoutePayloadRoutesInner struct {
GroupBy *[]string `json:"groupBy,omitempty"`
// As in one level above
GroupInterval *string `json:"groupInterval,omitempty"`
// As in one level above
GroupWait *string `json:"groupWait,omitempty"`
// As in one level above
Match *map[string]interface{} `json:"match,omitempty"`
// As in one level above
MatchRe *map[string]interface{} `json:"matchRe,omitempty"`
// As in one level above
Receiver *string `json:"receiver,omitempty"`
// As in one level above
RepeatInterval *string `json:"repeatInterval,omitempty"`
// Another child routes
Routes *[]map[string]interface{} `json:"routes,omitempty"`
}
CreateAlertConfigRoutePayloadRoutesInner As in one level above
type CreateCredentialsResponse ¶
type CreateCredentialsResponse struct {
// REQUIRED
Credentials *Credentials `json:"credentials"`
// REQUIRED
Message *string `json:"message"`
}
CreateCredentialsResponse struct for CreateCredentialsResponse
type CreateInstancePayload ¶
type CreateInstancePayload struct {
// Name of the service
Name *string `json:"name,omitempty"`
// additional parameters
Parameter *map[string]interface{} `json:"parameter,omitempty"`
// uuid of the plan to create/update
// REQUIRED
PlanId *string `json:"planId"`
}
CreateInstancePayload Create update instance body.
type CreateInstanceResponse ¶
type CreateInstanceResponse struct {
// REQUIRED
DashboardUrl *string `json:"dashboardUrl"`
// REQUIRED
InstanceId *string `json:"instanceId"`
// REQUIRED
Message *string `json:"message"`
}
CreateInstanceResponse struct for CreateInstanceResponse
type CreateScrapeConfigPayload ¶
type CreateScrapeConfigPayload struct {
BasicAuth *CreateScrapeConfigPayloadBasicAuth `json:"basicAuth,omitempty"`
// Sets the 'Authorization' header on every scrape request with the configured bearer token. It is mutually exclusive with 'bearer_token_file'. `Additional Validators:` * needs to be a valid bearer token * if bearerToken is in the body no other authentication method should be in the body
BearerToken *string `json:"bearerToken,omitempty"`
// Note that any globally configured 'external_labels' are unaffected by this setting. In communication with external systems, they are always applied only when a time series does not have a given label yet and are ignored otherwise.
HonorLabels *bool `json:"honorLabels,omitempty"`
// honor_timestamps controls whether Prometheus respects the timestamps present in scraped data. If honor_timestamps is set to 'true', the timestamps of the metrics exposed by the target will be used.
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
// HTTP-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms.
HttpSdConfigs *[]CreateScrapeConfigPayloadHttpSdConfigsInner `json:"httpSdConfigs,omitempty"`
// The job name assigned to scraped metrics by default. `Additional Validators:` * must be unique * key and values should only include the characters: a-zA-Z0-9-
// REQUIRED
JobName *string `json:"jobName"`
// The HTTP resource path on which to fetch metrics from targets. E.g. /metrics
MetricsPath *string `json:"metricsPath,omitempty"`
// List of metric relabel configurations
MetricsRelabelConfigs *[]CreateScrapeConfigPayloadMetricsRelabelConfigsInner `json:"metricsRelabelConfigs,omitempty"`
Oauth2 *CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2 `json:"oauth2,omitempty"`
// Optional http params `Additional Validators:` * should not contain more than 5 keys * each key and value should not have more than 200 characters
Params *map[string]interface{} `json:"params,omitempty"`
// Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabeling the entire scrape will be treated as failed. The total limit depends on the service plan target limits * samples
SampleLimit *float64 `json:"sampleLimit,omitempty"`
// Configures the protocol scheme used for requests. https or http
// REQUIRED
Scheme *string `json:"scheme"`
// How frequently to scrape targets from this job. E.g. 5m `Additional Validators:` * must be a valid time format* must be >= 60s
// REQUIRED
ScrapeInterval *string `json:"scrapeInterval"`
// Per-scrape timeout when scraping this job. `Additional Validators:` * must be a valid time format* must be smaller than scrapeInterval
// REQUIRED
ScrapeTimeout *string `json:"scrapeTimeout"`
// A list of scrape configurations.
// REQUIRED
StaticConfigs *[]CreateScrapeConfigPayloadStaticConfigsInner `json:"staticConfigs"`
TlsConfig *CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig `json:"tlsConfig,omitempty"`
}
CreateScrapeConfigPayload struct for CreateScrapeConfigPayload
type CreateScrapeConfigPayloadBasicAuth ¶
type CreateScrapeConfigPayloadBasicAuth struct {
// password
Password *string `json:"password,omitempty"`
// username
Username *string `json:"username,omitempty"`
}
CreateScrapeConfigPayloadBasicAuth Sets the 'Authorization' header on every scrape request with the configured username and password. `Additional Validators:` * if basicAuth is in the body no other authentication method should be in the body
type CreateScrapeConfigPayloadHttpSdConfigsInner ¶
type CreateScrapeConfigPayloadHttpSdConfigsInner struct {
BasicAuth *CreateScrapeConfigPayloadBasicAuth `json:"basicAuth,omitempty"`
Oauth2 *CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2 `json:"oauth2,omitempty"`
// Refresh interval to re-query the endpoint. E.g. 60s `Additional Validators:` * must be a valid time format* must be >= 60s
RefreshInterval *string `json:"refreshInterval,omitempty"`
TlsConfig *CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig `json:"tlsConfig,omitempty"`
// URL from which the targets are fetched.
// REQUIRED
Url *string `json:"url"`
}
CreateScrapeConfigPayloadHttpSdConfigsInner struct for CreateScrapeConfigPayloadHttpSdConfigsInner
type CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2 ¶
type CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2 struct {
// clientId
// REQUIRED
ClientId *string `json:"clientId"`
// clientSecret
// REQUIRED
ClientSecret *string `json:"clientSecret"`
// The URL to fetch the token from.
Scopes *[]string `json:"scopes,omitempty"`
TlsConfig *CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig `json:"tlsConfig,omitempty"`
// The URL to fetch the token from.
// REQUIRED
TokenUrl *string `json:"tokenUrl"`
}
CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2 OAuth 2.0 authentication using the client credentials grant type. Prometheus fetches an access token from the specified endpoint with the given client access and secret keys. `Additional Validators:` * if oauth2 is in the body no other authentication method should be in the body
type CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig ¶
type CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig struct {
// Disable validation of the server certificate.
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
}
CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig Configures the scrape request's TLS settings.
type CreateScrapeConfigPayloadMetricsRelabelConfigsInner ¶
type CreateScrapeConfigPayloadMetricsRelabelConfigsInner struct {
// Action to perform based on regex matching. `Additional Validators:` * if action is replace, targetLabel needs to be in body
Action *string `json:"action,omitempty"`
// Modulus to take of the hash of the source label values.
Modulus *float64 `json:"modulus,omitempty"`
// Regular expression against which the extracted value is matched.
Regex *string `json:"regex,omitempty"`
// Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available.
Replacement *string `json:"replacement,omitempty"`
// Separator placed between concatenated source label values.
Separator *string `json:"separator,omitempty"`
// The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.
SourceLabels *[]string `json:"sourceLabels,omitempty"`
// Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.
TargetLabel *string `json:"targetLabel,omitempty"`
}
CreateScrapeConfigPayloadMetricsRelabelConfigsInner struct for CreateScrapeConfigPayloadMetricsRelabelConfigsInner
type CreateScrapeConfigPayloadStaticConfigsInner ¶
type CreateScrapeConfigPayloadStaticConfigsInner struct {
// Labels assigned to all metrics scraped from the targets. `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"`
// The targets specified by the static config.
// REQUIRED
Targets *[]string `json:"targets"`
}
CreateScrapeConfigPayloadStaticConfigsInner struct for CreateScrapeConfigPayloadStaticConfigsInner
type Credentials ¶
type Credentials struct {
// REQUIRED
Password *string `json:"password"`
// REQUIRED
Username *string `json:"username"`
}
Credentials struct for Credentials
type CredentialsRemoteWriteConfig ¶
type CredentialsRemoteWriteConfig struct {
// REQUIRED
CredentialsMaxLimit *int64 `json:"credentialsMaxLimit"`
// REQUIRED
MaxLimit *int64 `json:"maxLimit"`
// REQUIRED
Message *string `json:"message"`
}
CredentialsRemoteWriteConfig struct for CredentialsRemoteWriteConfig
type CredentialsRemoteWriteDeleteResponse ¶
type CredentialsRemoteWriteDeleteResponse struct {
// REQUIRED
MaxLimit *int64 `json:"maxLimit"`
// REQUIRED
Message *string `json:"message"`
}
CredentialsRemoteWriteDeleteResponse struct for CredentialsRemoteWriteDeleteResponse
type DeleteScrapeConfigResponse ¶
type DeleteScrapeConfigResponse struct {
// REQUIRED
Data *[]Job `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
DeleteScrapeConfigResponse struct for DeleteScrapeConfigResponse
type EmailConfig ¶
type EmailConfig struct {
AuthIdentity *string `json:"authIdentity,omitempty"`
AuthPassword *string `json:"authPassword,omitempty"`
AuthUsername *string `json:"authUsername,omitempty"`
From *string `json:"from,omitempty"`
SendResolved *bool `json:"sendResolved,omitempty"`
Smarthost *string `json:"smarthost,omitempty"`
// REQUIRED
To *string `json:"to"`
}
EmailConfig struct for EmailConfig
type Error ¶
type Error struct {
Errors *[]map[string]string `json:"errors,omitempty"`
// REQUIRED
Message *string `json:"message"`
}
Error struct for Error
type GetAlertConfigsResponse ¶
type GetAlertConfigsResponse struct {
// REQUIRED
Data *Alert `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
GetAlertConfigsResponse struct for GetAlertConfigsResponse
type GetCredentialsResponse ¶
type GetCredentialsResponse struct {
CredentialsInfo *map[string]string `json:"credentialsInfo,omitempty"`
// REQUIRED
Id *string `json:"id"`
// REQUIRED
Message *string `json:"message"`
// REQUIRED
Name *string `json:"name"`
}
GetCredentialsResponse struct for GetCredentialsResponse
type GetInstanceResponse ¶
type GetInstanceResponse struct {
// REQUIRED
DashboardUrl *string `json:"dashboardUrl"`
// REQUIRED
Id *string `json:"id"`
// REQUIRED
Instance *InstanceSensitiveData `json:"instance"`
IsUpdatable *bool `json:"isUpdatable,omitempty"`
// REQUIRED
Message *string `json:"message"`
Name *string `json:"name,omitempty"`
Parameters *map[string]string `json:"parameters,omitempty"`
// REQUIRED
PlanId *string `json:"planId"`
// REQUIRED
PlanName *string `json:"planName"`
PlanSchema *string `json:"planSchema,omitempty"`
// REQUIRED
ServiceName *string `json:"serviceName"`
// REQUIRED
Status *string `json:"status"`
}
GetInstanceResponse struct for GetInstanceResponse
type GetMetricsStorageRetentionResponse ¶
type GetMetricsStorageRetentionResponse struct {
// REQUIRED
Message *string `json:"message"`
// REQUIRED
MetricsRetentionTime1h *string `json:"metricsRetentionTime1h"`
// REQUIRED
MetricsRetentionTime5m *string `json:"metricsRetentionTime5m"`
// REQUIRED
MetricsRetentionTimeRaw *string `json:"metricsRetentionTimeRaw"`
}
GetMetricsStorageRetentionResponse struct for GetMetricsStorageRetentionResponse
type GetScrapeConfigResponse ¶
type GetScrapeConfigResponse struct {
// REQUIRED
Data *Job `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
GetScrapeConfigResponse struct for GetScrapeConfigResponse
type Global ¶
type Global struct {
OpsgenieApiKey *string `json:"opsgenieApiKey,omitempty"`
OpsgenieApiUrl *string `json:"opsgenieApiUrl,omitempty"`
ResolveTimeout *string `json:"resolveTimeout,omitempty"`
SmtpAuthIdentity *string `json:"smtpAuthIdentity,omitempty"`
SmtpAuthPassword *string `json:"smtpAuthPassword,omitempty"`
SmtpAuthUsername *string `json:"smtpAuthUsername,omitempty"`
SmtpFrom *string `json:"smtpFrom,omitempty"`
SmtpSmarthost *string `json:"smtpSmarthost,omitempty"`
}
Global struct for Global
type GrafanaConfigs ¶
type GrafanaConfigs struct {
GenericOauth *GrafanaOauth `json:"genericOauth,omitempty"`
// REQUIRED
Message *string `json:"message"`
PublicReadAccess *bool `json:"publicReadAccess,omitempty"`
UseStackitSso *bool `json:"useStackitSso,omitempty"`
}
GrafanaConfigs struct for GrafanaConfigs
type GrafanaOauth ¶
type GrafanaOauth struct {
// REQUIRED
ApiUrl *string `json:"apiUrl"`
// REQUIRED
AuthUrl *string `json:"authUrl"`
// REQUIRED
Enabled *bool `json:"enabled"`
Name *string `json:"name,omitempty"`
// REQUIRED
OauthClientId *string `json:"oauthClientId"`
// REQUIRED
OauthClientSecret *string `json:"oauthClientSecret"`
// REQUIRED
RoleAttributePath *string `json:"roleAttributePath"`
RoleAttributeStrict *bool `json:"roleAttributeStrict,omitempty"`
Scopes *string `json:"scopes,omitempty"`
// REQUIRED
TokenUrl *string `json:"tokenUrl"`
UsePkce *bool `json:"usePkce,omitempty"`
}
GrafanaOauth struct for GrafanaOauth
type HTTPServiceSD ¶
type HTTPServiceSD struct {
BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
Oauth2 *OAuth2 `json:"oauth2,omitempty"`
RefreshInterval *string `json:"refreshInterval,omitempty"`
TlsConfig *TLSConfig `json:"tlsConfig,omitempty"`
// REQUIRED
Url *string `json:"url"`
}
HTTPServiceSD struct for HTTPServiceSD
type InhibitRules ¶
type InhibitRules struct {
Equal *[]string `json:"equal,omitempty"`
SourceMatch *map[string]string `json:"sourceMatch,omitempty"`
SourceMatchRe *map[string]string `json:"sourceMatchRe,omitempty"`
SourceMatchers *[]string `json:"sourceMatchers,omitempty"`
TargetMatch *map[string]string `json:"targetMatch,omitempty"`
TargetMatchRe *map[string]string `json:"targetMatchRe,omitempty"`
TargetMatchers *[]string `json:"targetMatchers,omitempty"`
}
InhibitRules struct for InhibitRules
type Instance ¶
type Instance struct {
// REQUIRED
Cluster *string `json:"cluster"`
// REQUIRED
GrafanaPublicReadAccess *bool `json:"grafanaPublicReadAccess"`
// REQUIRED
GrafanaUseStackitSso *bool `json:"grafanaUseStackitSso"`
// REQUIRED
Instance *string `json:"instance"`
// REQUIRED
MetricsRetentionTime1h *int64 `json:"metricsRetentionTime1h"`
// REQUIRED
MetricsRetentionTime5m *int64 `json:"metricsRetentionTime5m"`
// REQUIRED
MetricsRetentionTimeRaw *int64 `json:"metricsRetentionTimeRaw"`
Name *string `json:"name,omitempty"`
// REQUIRED
Plan *PlanModel `json:"plan"`
State *string `json:"state,omitempty"`
}
Instance struct for Instance
type InstanceResponse ¶
type InstanceResponse struct {
// REQUIRED
Message *string `json:"message"`
}
InstanceResponse struct for InstanceResponse
type InstanceSensitiveData ¶
type InstanceSensitiveData struct {
// REQUIRED
AlertingUrl *string `json:"alertingUrl"`
// REQUIRED
Cluster *string `json:"cluster"`
// REQUIRED
DashboardUrl *string `json:"dashboardUrl"`
// REQUIRED
GrafanaAdminPassword *string `json:"grafanaAdminPassword"`
// REQUIRED
GrafanaAdminUser *string `json:"grafanaAdminUser"`
// REQUIRED
GrafanaPublicReadAccess *bool `json:"grafanaPublicReadAccess"`
// REQUIRED
GrafanaUrl *string `json:"grafanaUrl"`
// REQUIRED
GrafanaUseStackitSso *bool `json:"grafanaUseStackitSso"`
// REQUIRED
Instance *string `json:"instance"`
// REQUIRED
JaegerTracesUrl *string `json:"jaegerTracesUrl"`
// REQUIRED
JaegerUiUrl *string `json:"jaegerUiUrl"`
// REQUIRED
LogsPushUrl *string `json:"logsPushUrl"`
// REQUIRED
LogsUrl *string `json:"logsUrl"`
// REQUIRED
MetricsRetentionTime1h *int64 `json:"metricsRetentionTime1h"`
// REQUIRED
MetricsRetentionTime5m *int64 `json:"metricsRetentionTime5m"`
// REQUIRED
MetricsRetentionTimeRaw *int64 `json:"metricsRetentionTimeRaw"`
// REQUIRED
MetricsUrl *string `json:"metricsUrl"`
Name *string `json:"name,omitempty"`
// REQUIRED
OtlpTracesUrl *string `json:"otlpTracesUrl"`
// REQUIRED
Plan *PlanModel `json:"plan"`
// REQUIRED
PushMetricsUrl *string `json:"pushMetricsUrl"`
// REQUIRED
TargetsUrl *string `json:"targetsUrl"`
// REQUIRED
ZipkinSpansUrl *string `json:"zipkinSpansUrl"`
}
InstanceSensitiveData struct for InstanceSensitiveData
type Job ¶
type Job struct {
BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
BearerToken *string `json:"bearerToken,omitempty"`
HonorLabels *bool `json:"honorLabels,omitempty"`
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
HttpSdConfigs *[]HTTPServiceSD `json:"httpSdConfigs,omitempty"`
// REQUIRED
JobName *string `json:"jobName"`
MetricsPath *string `json:"metricsPath,omitempty"`
MetricsRelabelConfigs *[]MetricsRelabelConfig `json:"metricsRelabelConfigs,omitempty"`
Oauth2 *OAuth2 `json:"oauth2,omitempty"`
Params *map[string][]string `json:"params,omitempty"`
SampleLimit *int64 `json:"sampleLimit,omitempty"`
Scheme *string `json:"scheme,omitempty"`
// REQUIRED
ScrapeInterval *string `json:"scrapeInterval"`
// REQUIRED
ScrapeTimeout *string `json:"scrapeTimeout"`
// REQUIRED
StaticConfigs *[]StaticConfigs `json:"staticConfigs"`
TlsConfig *TLSConfig `json:"tlsConfig,omitempty"`
}
Job struct for Job
type ListACLResponse ¶
type ListACLResponse struct {
// REQUIRED
Acl *[]string `json:"acl"`
// REQUIRED
Message *string `json:"message"`
}
ListACLResponse struct for ListACLResponse
type ListCredentialsResponse ¶
type ListCredentialsResponse struct {
// REQUIRED
Credentials *[]ServiceKeysList `json:"credentials"`
// REQUIRED
Message *string `json:"message"`
}
ListCredentialsResponse struct for ListCredentialsResponse
type ListInstancesResponse ¶
type ListInstancesResponse struct {
// REQUIRED
Instances *[]ProjectInstanceFull `json:"instances"`
// REQUIRED
Message *string `json:"message"`
}
ListInstancesResponse struct for ListInstancesResponse
type ListScrapeConfigsResponse ¶
type ListScrapeConfigsResponse struct {
// REQUIRED
Data *[]Job `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
ListScrapeConfigsResponse struct for ListScrapeConfigsResponse
type MappedNullable ¶
type Message ¶
type Message struct {
// REQUIRED
Message *string `json:"message"`
}
Message struct for Message
type MetricsRelabelConfig ¶
type MetricsRelabelConfig struct {
Action *string `json:"action,omitempty"`
Modulus *int64 `json:"modulus,omitempty"`
Regex *string `json:"regex,omitempty"`
Replacement *string `json:"replacement,omitempty"`
Separator *string `json:"separator,omitempty"`
// REQUIRED
SourceLabels *[]string `json:"sourceLabels"`
TargetLabel *string `json:"targetLabel,omitempty"`
}
MetricsRelabelConfig struct for MetricsRelabelConfig
type NullableBool ¶
type NullableBool struct {
// contains filtered or unexported fields
}
func NewNullableBool ¶
func NewNullableBool(val *bool) *NullableBool
func (NullableBool) Get ¶
func (v NullableBool) Get() *bool
func (NullableBool) IsSet ¶
func (v NullableBool) IsSet() bool
func (NullableBool) MarshalJSON ¶
func (v NullableBool) MarshalJSON() ([]byte, error)
func (*NullableBool) Set ¶
func (v *NullableBool) Set(val *bool)
func (*NullableBool) UnmarshalJSON ¶
func (v *NullableBool) UnmarshalJSON(src []byte) error
func (*NullableBool) Unset ¶
func (v *NullableBool) Unset()
type NullableFloat32 ¶
type NullableFloat32 struct {
// contains filtered or unexported fields
}
func NewNullableFloat32 ¶
func NewNullableFloat32(val *float32) *NullableFloat32
func (NullableFloat32) Get ¶
func (v NullableFloat32) Get() *float32
func (NullableFloat32) IsSet ¶
func (v NullableFloat32) IsSet() bool
func (NullableFloat32) MarshalJSON ¶
func (v NullableFloat32) MarshalJSON() ([]byte, error)
func (*NullableFloat32) Set ¶
func (v *NullableFloat32) Set(val *float32)
func (*NullableFloat32) UnmarshalJSON ¶
func (v *NullableFloat32) UnmarshalJSON(src []byte) error
func (*NullableFloat32) Unset ¶
func (v *NullableFloat32) Unset()
type NullableFloat64 ¶
type NullableFloat64 struct {
// contains filtered or unexported fields
}
func NewNullableFloat64 ¶
func NewNullableFloat64(val *float64) *NullableFloat64
func (NullableFloat64) Get ¶
func (v NullableFloat64) Get() *float64
func (NullableFloat64) IsSet ¶
func (v NullableFloat64) IsSet() bool
func (NullableFloat64) MarshalJSON ¶
func (v NullableFloat64) MarshalJSON() ([]byte, error)
func (*NullableFloat64) Set ¶
func (v *NullableFloat64) Set(val *float64)
func (*NullableFloat64) UnmarshalJSON ¶
func (v *NullableFloat64) UnmarshalJSON(src []byte) error
func (*NullableFloat64) Unset ¶
func (v *NullableFloat64) Unset()
type NullableInt ¶
type NullableInt struct {
// contains filtered or unexported fields
}
func NewNullableInt ¶
func NewNullableInt(val *int) *NullableInt
func (NullableInt) Get ¶
func (v NullableInt) Get() *int
func (NullableInt) IsSet ¶
func (v NullableInt) IsSet() bool
func (NullableInt) MarshalJSON ¶
func (v NullableInt) MarshalJSON() ([]byte, error)
func (*NullableInt) Set ¶
func (v *NullableInt) Set(val *int)
func (*NullableInt) UnmarshalJSON ¶
func (v *NullableInt) UnmarshalJSON(src []byte) error
func (*NullableInt) Unset ¶
func (v *NullableInt) Unset()
type NullableInt32 ¶
type NullableInt32 struct {
// contains filtered or unexported fields
}
func NewNullableInt32 ¶
func NewNullableInt32(val *int32) *NullableInt32
func (NullableInt32) Get ¶
func (v NullableInt32) Get() *int32
func (NullableInt32) IsSet ¶
func (v NullableInt32) IsSet() bool
func (NullableInt32) MarshalJSON ¶
func (v NullableInt32) MarshalJSON() ([]byte, error)
func (*NullableInt32) Set ¶
func (v *NullableInt32) Set(val *int32)
func (*NullableInt32) UnmarshalJSON ¶
func (v *NullableInt32) UnmarshalJSON(src []byte) error
func (*NullableInt32) Unset ¶
func (v *NullableInt32) Unset()
type NullableInt64 ¶
type NullableInt64 struct {
// contains filtered or unexported fields
}
func NewNullableInt64 ¶
func NewNullableInt64(val *int64) *NullableInt64
func (NullableInt64) Get ¶
func (v NullableInt64) Get() *int64
func (NullableInt64) IsSet ¶
func (v NullableInt64) IsSet() bool
func (NullableInt64) MarshalJSON ¶
func (v NullableInt64) MarshalJSON() ([]byte, error)
func (*NullableInt64) Set ¶
func (v *NullableInt64) Set(val *int64)
func (*NullableInt64) UnmarshalJSON ¶
func (v *NullableInt64) UnmarshalJSON(src []byte) error
func (*NullableInt64) Unset ¶
func (v *NullableInt64) Unset()
type NullableString ¶
type NullableString struct {
// contains filtered or unexported fields
}
func NewNullableString ¶
func NewNullableString(val *string) *NullableString
func (NullableString) Get ¶
func (v NullableString) Get() *string
func (NullableString) IsSet ¶
func (v NullableString) IsSet() bool
func (NullableString) MarshalJSON ¶
func (v NullableString) MarshalJSON() ([]byte, error)
func (*NullableString) Set ¶
func (v *NullableString) Set(val *string)
func (*NullableString) UnmarshalJSON ¶
func (v *NullableString) UnmarshalJSON(src []byte) error
func (*NullableString) Unset ¶
func (v *NullableString) Unset()
type NullableTime ¶
type NullableTime struct {
// contains filtered or unexported fields
}
func NewNullableTime ¶
func NewNullableTime(val *time.Time) *NullableTime
func (NullableTime) Get ¶
func (v NullableTime) Get() *time.Time
func (NullableTime) IsSet ¶
func (v NullableTime) IsSet() bool
func (NullableTime) MarshalJSON ¶
func (v NullableTime) MarshalJSON() ([]byte, error)
func (*NullableTime) Set ¶
func (v *NullableTime) Set(val *time.Time)
func (*NullableTime) UnmarshalJSON ¶
func (v *NullableTime) UnmarshalJSON(src []byte) error
func (*NullableTime) Unset ¶
func (v *NullableTime) Unset()
type OAuth2 ¶
type OAuth2 struct {
// REQUIRED
ClientId *string `json:"clientId"`
// REQUIRED
ClientSecret *string `json:"clientSecret"`
Scopes *[]string `json:"scopes,omitempty"`
TlsConfig *TLSConfig `json:"tlsConfig,omitempty"`
// REQUIRED
TokenUrl *string `json:"tokenUrl"`
}
OAuth2 struct for OAuth2
type OpsgenieConfig ¶
type OpsgenieConfig struct {
ApiKey *string `json:"apiKey,omitempty"`
ApiUrl *string `json:"apiUrl,omitempty"`
Priority *string `json:"priority,omitempty"`
SendResolved *bool `json:"sendResolved,omitempty"`
Tags *string `json:"tags,omitempty"`
}
OpsgenieConfig struct for OpsgenieConfig
type PermissionDenied ¶
type PermissionDenied struct {
// REQUIRED
Detail *string `json:"detail"`
}
PermissionDenied struct for PermissionDenied
type Plan ¶
type Plan struct {
// REQUIRED
AlertMatchers *int64 `json:"alertMatchers"`
// REQUIRED
AlertReceivers *int64 `json:"alertReceivers"`
// REQUIRED
AlertRules *int64 `json:"alertRules"`
Amount *float64 `json:"amount,omitempty"`
// REQUIRED
BucketSize *int64 `json:"bucketSize"`
Description *string `json:"description,omitempty"`
// REQUIRED
GrafanaGlobalDashboards *int64 `json:"grafanaGlobalDashboards"`
// REQUIRED
GrafanaGlobalOrgs *int64 `json:"grafanaGlobalOrgs"`
// REQUIRED
GrafanaGlobalSessions *int64 `json:"grafanaGlobalSessions"`
// REQUIRED
GrafanaGlobalUsers *int64 `json:"grafanaGlobalUsers"`
// REQUIRED
Id *string `json:"id"`
IsFree *bool `json:"isFree,omitempty"`
IsPublic *bool `json:"isPublic,omitempty"`
// REQUIRED
LogsAlert *int64 `json:"logsAlert"`
// REQUIRED
LogsStorage *int64 `json:"logsStorage"`
Name *string `json:"name,omitempty"`
// REQUIRED
PlanId *string `json:"planId"`
// REQUIRED
SamplesPerScrape *int64 `json:"samplesPerScrape"`
Schema *string `json:"schema,omitempty"`
// REQUIRED
TargetNumber *int64 `json:"targetNumber"`
// REQUIRED
TotalMetricSamples *int64 `json:"totalMetricSamples"`
// REQUIRED
TracesStorage *int64 `json:"tracesStorage"`
}
Plan struct for Plan
type PlanModel ¶
type PlanModel struct {
// REQUIRED
AlertMatchers *int64 `json:"alertMatchers"`
// REQUIRED
AlertReceivers *int64 `json:"alertReceivers"`
// REQUIRED
AlertRules *int64 `json:"alertRules"`
Amount *float64 `json:"amount,omitempty"`
// REQUIRED
BucketSize *int64 `json:"bucketSize"`
Description *string `json:"description,omitempty"`
// REQUIRED
GrafanaGlobalDashboards *int64 `json:"grafanaGlobalDashboards"`
// REQUIRED
GrafanaGlobalOrgs *int64 `json:"grafanaGlobalOrgs"`
// REQUIRED
GrafanaGlobalSessions *int64 `json:"grafanaGlobalSessions"`
// REQUIRED
GrafanaGlobalUsers *int64 `json:"grafanaGlobalUsers"`
// REQUIRED
Id *string `json:"id"`
// REQUIRED
LogsAlert *int64 `json:"logsAlert"`
// REQUIRED
LogsStorage *int64 `json:"logsStorage"`
Name *string `json:"name,omitempty"`
// REQUIRED
PlanId *string `json:"planId"`
// REQUIRED
SamplesPerScrape *int64 `json:"samplesPerScrape"`
// REQUIRED
TargetNumber *int64 `json:"targetNumber"`
// REQUIRED
TotalMetricSamples *int64 `json:"totalMetricSamples"`
// REQUIRED
TracesStorage *int64 `json:"tracesStorage"`
}
PlanModel struct for PlanModel
type PlansResponse ¶
type PlansResponse struct {
// REQUIRED
Message *string `json:"message"`
// REQUIRED
Plans *[]Plan `json:"plans"`
}
PlansResponse struct for PlansResponse
type ProjectInstanceFull ¶
type ProjectInstanceFull struct {
// REQUIRED
Id *string `json:"id"`
// REQUIRED
Instance *string `json:"instance"`
Name *string `json:"name,omitempty"`
// REQUIRED
PlanName *string `json:"planName"`
// REQUIRED
ServiceName *string `json:"serviceName"`
// REQUIRED
Status *string `json:"status"`
}
ProjectInstanceFull struct for ProjectInstanceFull
type Receiver ¶
type Receiver struct {
// REQUIRED
Data *Receivers `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
Receiver struct for Receiver
type Receivers ¶
type Receivers struct {
EmailConfigs *[]EmailConfig `json:"emailConfigs,omitempty"`
// REQUIRED
Name *string `json:"name"`
OpsgenieConfigs *[]OpsgenieConfig `json:"opsgenieConfigs,omitempty"`
WebHookConfigs *[]WebHook `json:"webHookConfigs,omitempty"`
}
Receivers struct for Receivers
type Route ¶
type Route struct {
Continue *bool `json:"continue,omitempty"`
GroupBy *[]string `json:"groupBy,omitempty"`
GroupInterval *string `json:"groupInterval,omitempty"`
GroupWait *string `json:"groupWait,omitempty"`
Match *map[string]string `json:"match,omitempty"`
MatchRe *map[string]string `json:"matchRe,omitempty"`
// REQUIRED
Receiver *string `json:"receiver"`
RepeatInterval *string `json:"repeatInterval,omitempty"`
Routes *[]RouteSerializer `json:"routes,omitempty"`
}
Route struct for Route
type RouteSerializer ¶
type RouteSerializer struct {
Continue *bool `json:"continue,omitempty"`
GroupBy *[]string `json:"groupBy,omitempty"`
GroupInterval *string `json:"groupInterval,omitempty"`
GroupWait *string `json:"groupWait,omitempty"`
Match *map[string]string `json:"match,omitempty"`
MatchRe *map[string]string `json:"matchRe,omitempty"`
Matchers *[]string `json:"matchers,omitempty"`
// REQUIRED
Receiver *string `json:"receiver"`
RepeatInterval *string `json:"repeatInterval,omitempty"`
Routes *[]map[string]string `json:"routes,omitempty"`
}
RouteSerializer struct for RouteSerializer
type ScrapeConfigsResponse ¶
type ScrapeConfigsResponse struct {
// REQUIRED
Data *[]Job `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
ScrapeConfigsResponse struct for ScrapeConfigsResponse
type ServiceKeysList ¶
type ServiceKeysList struct {
CredentialsInfo *map[string]string `json:"credentialsInfo,omitempty"`
// REQUIRED
Id *string `json:"id"`
// REQUIRED
Name *string `json:"name"`
}
ServiceKeysList struct for ServiceKeysList
type StaticConfigs ¶
type StaticConfigs struct {
Labels *map[string]string `json:"labels,omitempty"`
// REQUIRED
Targets *[]string `json:"targets"`
}
StaticConfigs struct for StaticConfigs
type TLSConfig ¶
type TLSConfig struct {
InsecureSkipVerify *bool `json:"insecureSkipVerify,omitempty"`
}
TLSConfig struct for TLSConfig
type UpdateACLPayload ¶
type UpdateACLPayload struct {
// list of cidr
// REQUIRED
Acl *[]string `json:"acl"`
}
UpdateACLPayload List of cidr. Send empty string to remove acl.
type UpdateAlertConfigReceiverPayload ¶
type UpdateAlertConfigReceiverPayload struct {
// Email configurations
EmailConfigs *[]CreateAlertConfigReceiverPayloadEmailConfigsInner `json:"emailConfigs,omitempty"`
// `Additional Validators:` * must be unique * should only include the characters: a-zA-Z0-9-
// REQUIRED
Name *string `json:"name"`
// Configuration for ops genie.
OpsgenieConfigs *[]CreateAlertConfigReceiverPayloadOpsgenieConfigsInner `json:"opsgenieConfigs,omitempty"`
WebHookConfigs *[]CreateAlertConfigReceiverPayloadWebHookConfigsInner `json:"webHookConfigs,omitempty"`
}
UpdateAlertConfigReceiverPayload Receivers
type UpdateAlertConfigRoutePayload ¶
type UpdateAlertConfigRoutePayload struct {
// The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupBy *[]string `json:"groupBy,omitempty"`
// How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.) `Additional Validators:` * must be a valid time format
GroupInterval *string `json:"groupInterval,omitempty"`
// How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) `Additional Validators:` * must be a valid time format
GroupWait *string `json:"groupWait,omitempty"`
// map of key:value. A set of equality matchers an alert has to fulfill to match the node. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters * key and values should only include the characters: a-zA-Z0-9_./@&?:-
Match *map[string]interface{} `json:"match,omitempty"`
// map of key:value. A set of regex-matchers an alert has to fulfill to match the node. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters
MatchRe *map[string]interface{} `json:"matchRe,omitempty"`
// A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics. The syntax of a matcher consists of three tokens: * A valid Prometheus label name. * One of =, !=, =~, or !~. = means equals, != means that the strings are not equal, =~ is used for equality of regex expressions and !~ is used for un-equality of regex expressions. They have the same meaning as known from PromQL selectors. * A UTF-8 string, which may be enclosed in double quotes. Before or after each token, there may be any amount of whitespace. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters
Matchers *[]string `json:"matchers,omitempty"`
// Receiver that should be one item of receivers `Additional Validators:` * must be a in name of receivers
// REQUIRED
Receiver *string `json:"receiver"`
// How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more). `Additional Validators:` * must be a valid time format
RepeatInterval *string `json:"repeatInterval,omitempty"`
// Zero or more child routes.
Routes *[]CreateAlertConfigRoutePayloadRoutesInner `json:"routes,omitempty"`
}
UpdateAlertConfigRoutePayload The root node of the routing tree.
type UpdateAlertConfigsPayload ¶
type UpdateAlertConfigsPayload struct {
Global *UpdateAlertConfigsPayloadGlobal `json:"global,omitempty"`
InhibitRules *UpdateAlertConfigsPayloadInhibitRules `json:"inhibitRules,omitempty"`
// A list of notification receivers.
// REQUIRED
Receivers *[]UpdateAlertConfigsPayloadReceiversInner `json:"receivers"`
// REQUIRED
Route *UpdateAlertConfigsPayloadRoute `json:"route"`
}
UpdateAlertConfigsPayload Alert config
type UpdateAlertConfigsPayloadGlobal ¶
type UpdateAlertConfigsPayloadGlobal struct {
// Opsgenie api key `Additional Validators:` * should only include the characters: a-zA-Z0-9-
OpsgenieApiKey *string `json:"opsgenieApiKey,omitempty"`
// Opsgenie api url `Additional Validators:` * must be a syntactically valid url address
OpsgenieApiUrl *string `json:"opsgenieApiUrl,omitempty"`
// ResolveTimeout is the default value used by alertmanager if the alert does not include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt. `Additional Validators:` * must be a valid time format
ResolveTimeout *string `json:"resolveTimeout,omitempty"`
// Auth identity. `Additional Validators:` * must be a syntactically valid email address
SmtpAuthIdentity *string `json:"smtpAuthIdentity,omitempty"`
// SMTP Auth using LOGIN and PLAIN.
SmtpAuthPassword *string `json:"smtpAuthPassword,omitempty"`
// SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
SmtpAuthUsername *string `json:"smtpAuthUsername,omitempty"`
// The default SMTP From header field. `Additional Validators:` * must be a syntactically valid email address
SmtpFrom *string `json:"smtpFrom,omitempty"`
// The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS). Example: smtp.example.org:587 `Additional Validators:` * should only include the characters: a-zA-Z0-9_./@&?:-
SmtpSmarthost *string `json:"smtpSmarthost,omitempty"`
}
UpdateAlertConfigsPayloadGlobal Global config. If nothing passed the default argus config will be used.
type UpdateAlertConfigsPayloadInhibitRules ¶
type UpdateAlertConfigsPayloadInhibitRules struct {
// Labels that must have an equal value in the source and target alert for the inhibition to take effect. `Additional Validators:` * should only include the characters: a-zA-Z0-9_./@&?:-
Equal *[]string `json:"equal,omitempty"`
// map of key:value. Matchers for which one or more alerts have to exist for the inhibition to take effect. `Additional Validators:` * should not contain more than 5 keys * each key and value should not have more than 200 characters * each key and value should only include the characters: a-zA-Z0-9_./@&?:-
SourceMatch *map[string]interface{} `json:"sourceMatch,omitempty"`
// map of key:value. Regex match `Additional Validators:` * should not contain more than 5 keys * each key and value should not have more than 200 characters
SourceMatchRe *map[string]interface{} `json:"sourceMatchRe,omitempty"`
// map of key:value. Matchers that have to be fulfilled in the alerts to be muted. `Additional Validators:` * should not contain more than 5 keys * each key and value should not have more than 200 characters * each key and value should only include the characters: a-zA-Z0-9_./@&?:-
TargetMatch *map[string]interface{} `json:"targetMatch,omitempty"`
// map of key:value. Matchers that have to be fulfilled in the alerts to be muted. Regex. `Additional Validators:` * should not contain more than 5 keys * each key and value should not have more than 200 characters
TargetMatchRe *map[string]interface{} `json:"targetMatchRe,omitempty"`
}
UpdateAlertConfigsPayloadInhibitRules A list of inhibition rules.
type UpdateAlertConfigsPayloadReceiversInner ¶
type UpdateAlertConfigsPayloadReceiversInner struct {
// Email configurations
EmailConfigs *[]CreateAlertConfigReceiverPayloadEmailConfigsInner `json:"emailConfigs,omitempty"`
// `Additional Validators:` * must be unique * should only include the characters: a-zA-Z0-9-
// REQUIRED
Name *string `json:"name"`
// Configuration for ops genie.
OpsgenieConfigs *[]CreateAlertConfigReceiverPayloadOpsgenieConfigsInner `json:"opsgenieConfigs,omitempty"`
WebHookConfigs *[]CreateAlertConfigReceiverPayloadWebHookConfigsInner `json:"webHookConfigs,omitempty"`
}
UpdateAlertConfigsPayloadReceiversInner Receivers
type UpdateAlertConfigsPayloadRoute ¶
type UpdateAlertConfigsPayloadRoute struct {
// The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupBy *[]string `json:"groupBy,omitempty"`
// How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.) `Additional Validators:` * must be a valid time format
GroupInterval *string `json:"groupInterval,omitempty"`
// How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) `Additional Validators:` * must be a valid time format
GroupWait *string `json:"groupWait,omitempty"`
// map of key:value. A set of equality matchers an alert has to fulfill to match the node. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters * key and values should only include the characters: a-zA-Z0-9_./@&?:-
Match *map[string]interface{} `json:"match,omitempty"`
// map of key:value. A set of regex-matchers an alert has to fulfill to match the node. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters
MatchRe *map[string]interface{} `json:"matchRe,omitempty"`
// A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics. The syntax of a matcher consists of three tokens: * A valid Prometheus label name. * One of =, !=, =~, or !~. = means equals, != means that the strings are not equal, =~ is used for equality of regex expressions and !~ is used for un-equality of regex expressions. They have the same meaning as known from PromQL selectors. * A UTF-8 string, which may be enclosed in double quotes. Before or after each token, there may be any amount of whitespace. `Additional Validators:` * should not contain more than 5 keys * each key and value should not be longer than 200 characters
Matchers *[]string `json:"matchers,omitempty"`
// Receiver that should be one item of receivers `Additional Validators:` * must be a in name of receivers
// REQUIRED
Receiver *string `json:"receiver"`
// How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more). `Additional Validators:` * must be a valid time format
RepeatInterval *string `json:"repeatInterval,omitempty"`
// Zero or more child routes.
Routes *[]CreateAlertConfigRoutePayloadRoutesInner `json:"routes,omitempty"`
}
UpdateAlertConfigsPayloadRoute The root node of the routing tree.
type UpdateAlertConfigsResponse ¶
type UpdateAlertConfigsResponse struct {
// REQUIRED
Data *Alert `json:"data"`
// REQUIRED
Message *string `json:"message"`
}
UpdateAlertConfigsResponse struct for UpdateAlertConfigsResponse
type UpdateCredentialsRemoteWriteConfigPayload ¶
type UpdateCredentialsRemoteWriteConfigPayload struct {
// Remote write metric sample limit for credential to push in a single minute.
MaxLimit *float64 `json:"maxLimit,omitempty"`
}
UpdateCredentialsRemoteWriteConfigPayload Remote write limit config.
type UpdateGrafanaConfigsPayload ¶
type UpdateGrafanaConfigsPayload struct {
GenericOauth *UpdateGrafanaConfigsPayloadGenericOauth `json:"genericOauth,omitempty"`
// If it's true, anyone can access the Grafana dashboards without logging in. If it is wrong, a login is required.
PublicReadAccess *bool `json:"publicReadAccess,omitempty"`
// If it's true, it overwrites the current genericOauth config and configures STACKIT SSO for this instance.
UseStackitSso *bool `json:"useStackitSso,omitempty"`
}
UpdateGrafanaConfigsPayload Sending any of the attributes results in a set of the attribute and overwrites any previous configuration.
type UpdateGrafanaConfigsPayloadGenericOauth ¶
type UpdateGrafanaConfigsPayloadGenericOauth struct {
// Set api_url to the resource that returns OpenID UserInfo compatible information.
// REQUIRED
ApiUrl *string `json:"apiUrl"`
// Authentication endpoint of idp.
// REQUIRED
AuthUrl *string `json:"authUrl"`
// enable or disable generic oauth login
// REQUIRED
Enabled *bool `json:"enabled"`
// Display name for the oAuth provider
Name *string `json:"name,omitempty"`
// Oauth client id for auth endpoint.
// REQUIRED
OauthClientId *string `json:"oauthClientId"`
// Oauth client secret for auth endpoint.
// REQUIRED
OauthClientSecret *string `json:"oauthClientSecret"`
// Grafana checks for the presence of a role using the JMESPath specified via the role_attribute_path configuration option. The JMESPath is applied to the id_token first. If there is no match, then the UserInfo endpoint specified via the api_url configuration option is tried next. The result after evaluation of the role_attribute_path JMESPath expression should be a valid Grafana role, for example, Viewer, Editor or Admin For example: contains(roles[\\*], 'grafana-admin') && 'Admin' || contains(roles[\\*], 'grafana-editor') && 'Editor' || contains(roles[\\*], 'grafana-viewer') && 'Viewer'
// REQUIRED
RoleAttributePath *string `json:"roleAttributePath"`
// If therole_attribute_path property does not return a role, then the user is assigned the Viewer role by default. You can disable the role assignment by setting role_attribute_strict = true. It denies user access if no role or an invalid role is returned.
RoleAttributeStrict *bool `json:"roleAttributeStrict,omitempty"`
// Space seperated list of scopes of the token
Scopes *string `json:"scopes,omitempty"`
// Token endpoint of the idp.
// REQUIRED
TokenUrl *string `json:"tokenUrl"`
// enable or disable Proof Key for Code Exchange
UsePkce *bool `json:"usePkce,omitempty"`
}
UpdateGrafanaConfigsPayloadGenericOauth struct for UpdateGrafanaConfigsPayloadGenericOauth
type UpdateInstancePayload ¶
type UpdateInstancePayload struct {
// Name of the service
Name *string `json:"name,omitempty"`
// additional parameters
Parameter *map[string]interface{} `json:"parameter,omitempty"`
// uuid of the plan to create/update
// REQUIRED
PlanId *string `json:"planId"`
}
UpdateInstancePayload Create update instance body.
type UpdateMetricsStorageRetentionPayload ¶
type UpdateMetricsStorageRetentionPayload struct {
// 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
// REQUIRED
MetricsRetentionTime1h *string `json:"metricsRetentionTime1h"`
// 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
// REQUIRED
MetricsRetentionTime5m *string `json:"metricsRetentionTime5m"`
// 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
// REQUIRED
MetricsRetentionTimeRaw *string `json:"metricsRetentionTimeRaw"`
}
UpdateMetricsStorageRetentionPayload struct for UpdateMetricsStorageRetentionPayload
type UpdateScrapeConfigPayload ¶
type UpdateScrapeConfigPayload struct {
BasicAuth *CreateScrapeConfigPayloadBasicAuth `json:"basicAuth,omitempty"`
// Sets the 'Authorization' header on every scrape request with the configured bearer token. It is mutually exclusive with 'bearer_token_file'. `Additional Validators:` * needs to be a valid bearer token * if bearerToken is in the body no other authentication method should be in the body
BearerToken *string `json:"bearerToken,omitempty"`
// Note that any globally configured 'external_labels' are unaffected by this setting. In communication with external systems, they are always applied only when a time series does not have a given label yet and are ignored otherwise.
HonorLabels *bool `json:"honorLabels,omitempty"`
// honor_timestamps controls whether Prometheus respects the timestamps present in scraped data. If honor_timestamps is set to 'true', the timestamps of the metrics exposed by the target will be used.
HonorTimeStamps *bool `json:"honorTimeStamps,omitempty"`
// The HTTP resource path on which to fetch metrics from targets. E.g. /metrics
// REQUIRED
MetricsPath *string `json:"metricsPath"`
// List of metric relabel configurations
MetricsRelabelConfigs *[]CreateScrapeConfigPayloadMetricsRelabelConfigsInner `json:"metricsRelabelConfigs,omitempty"`
// Optional http params `Additional Validators:` * should not contain more than 5 keys * each key and value should not have more than 200 characters
Params *map[string]interface{} `json:"params,omitempty"`
// Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabeling the entire scrape will be treated as failed. The total limit depends on the service plan target limits * samples
SampleLimit *float64 `json:"sampleLimit,omitempty"`
// Configures the protocol scheme used for requests. https or http
// REQUIRED
Scheme *string `json:"scheme"`
// How frequently to scrape targets from this job. E.g. 5m `Additional Validators:` * must be a valid time format* must be >= 60s
// REQUIRED
ScrapeInterval *string `json:"scrapeInterval"`
// Per-scrape timeout when scraping this job. `Additional Validators:` * must be a valid time format* must be smaller than scrapeInterval
// REQUIRED
ScrapeTimeout *string `json:"scrapeTimeout"`
// A list of scrape configurations.
// REQUIRED
StaticConfigs *[]UpdateScrapeConfigPayloadStaticConfigsInner `json:"staticConfigs"`
TlsConfig *CreateScrapeConfigPayloadHttpSdConfigsInnerOauth2TlsConfig `json:"tlsConfig,omitempty"`
}
UpdateScrapeConfigPayload struct for UpdateScrapeConfigPayload
type UpdateScrapeConfigPayloadStaticConfigsInner ¶
type UpdateScrapeConfigPayloadStaticConfigsInner struct {
// Labels assigned to all metrics scraped from the targets. `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"`
// The targets specified by the static config.
// REQUIRED
Targets *[]string `json:"targets"`
}
UpdateScrapeConfigPayloadStaticConfigsInner struct for UpdateScrapeConfigPayloadStaticConfigsInner
Source Files
¶
- api_default.go
- client.go
- configuration.go
- model_alert.go
- model_alert_config_receivers_response.go
- model_alert_config_route_response.go
- model_basic_auth.go
- model_create_alert_config_receiver_payload.go
- model_create_alert_config_receiver_payload_email_configs_inner.go
- model_create_alert_config_receiver_payload_opsgenie_configs_inner.go
- model_create_alert_config_receiver_payload_web_hook_configs_inner.go
- model_create_alert_config_route_payload.go
- model_create_alert_config_route_payload_routes_inner.go
- model_create_credentials_response.go
- model_create_instance_payload.go
- model_create_instance_response.go
- model_create_scrape_config_payload.go
- model_create_scrape_config_payload_basic_auth.go
- model_create_scrape_config_payload_http_sd_configs_inner.go
- model_create_scrape_config_payload_http_sd_configs_inner_oauth2.go
- model_create_scrape_config_payload_http_sd_configs_inner_oauth2_tls_config.go
- model_create_scrape_config_payload_metrics_relabel_configs_inner.go
- model_create_scrape_config_payload_static_configs_inner.go
- model_credentials.go
- model_credentials_remote_write_config.go
- model_credentials_remote_write_delete_response.go
- model_delete_scrape_config_response.go
- model_email_config.go
- model_error.go
- model_get_alert_configs_response.go
- model_get_credentials_response.go
- model_get_instance_response.go
- model_get_metrics_storage_retention_response.go
- model_get_scrape_config_response.go
- model_global.go
- model_grafana_configs.go
- model_grafana_oauth.go
- model_http_service_sd.go
- model_inhibit_rules.go
- model_instance.go
- model_instance_response.go
- model_instance_sensitive_data.go
- model_job.go
- model_list_acl_response.go
- model_list_credentials_response.go
- model_list_instances_response.go
- model_list_scrape_configs_response.go
- model_message.go
- model_metrics_relabel_config.go
- model_o_auth2.go
- model_opsgenie_config.go
- model_permission_denied.go
- model_plan.go
- model_plan_model.go
- model_plans_response.go
- model_project_instance_full.go
- model_receiver.go
- model_receivers.go
- model_route.go
- model_route_serializer.go
- model_scrape_configs_response.go
- model_service_keys_list.go
- model_static_configs.go
- model_tls_config.go
- model_update_acl_payload.go
- model_update_alert_config_receiver_payload.go
- model_update_alert_config_route_payload.go
- model_update_alert_configs_payload.go
- model_update_alert_configs_payload_global.go
- model_update_alert_configs_payload_inhibit_rules.go
- model_update_alert_configs_payload_receivers_inner.go
- model_update_alert_configs_payload_route.go
- model_update_alert_configs_response.go
- model_update_credentials_remote_write_config_payload.go
- model_update_grafana_configs_payload.go
- model_update_grafana_configs_payload_generic_oauth.go
- model_update_instance_payload.go
- model_update_metrics_storage_retention_payload.go
- model_update_scrape_config_payload.go
- model_update_scrape_config_payload_static_configs_inner.go
- model_web_hook.go
- utils.go