v1beta1

package
v0.95.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 10, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlertmanagerConfigApplyConfiguration

type AlertmanagerConfigApplyConfiguration struct {
	// TypeMeta defines the versioned schema of this representation of an object.
	v1.TypeMetaApplyConfiguration `json:""`
	// metadata defines ObjectMeta as the metadata that all persisted resources.
	*v1.ObjectMetaApplyConfiguration `json:"metadata,omitempty"`
	// spec defines the specification of AlertmanagerConfigSpec
	Spec *AlertmanagerConfigSpecApplyConfiguration `json:"spec,omitempty"`
	// status defines the status subresource. It is under active development and is updated only when the
	// "StatusForConfigurationResources" feature gate is enabled.
	//
	// Most recent observed status of the ServiceMonitor. Read-only.
	// More info:
	// https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Status *monitoringv1.ConfigResourceStatusApplyConfiguration `json:"status,omitempty"`
}

AlertmanagerConfigApplyConfiguration represents a declarative configuration of the AlertmanagerConfig type for use with apply.

The `AlertmanagerConfig` custom resource definition (CRD) defines how `Alertmanager` objects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules.

`Alertmanager` objects select `AlertmanagerConfig` objects using label and namespace selectors.

func AlertmanagerConfig

func AlertmanagerConfig(name, namespace string) *AlertmanagerConfigApplyConfiguration

AlertmanagerConfig constructs a declarative configuration of the AlertmanagerConfig type for use with apply.

func (*AlertmanagerConfigApplyConfiguration) GetAPIVersion added in v0.86.0

func (b *AlertmanagerConfigApplyConfiguration) GetAPIVersion() *string

GetAPIVersion retrieves the value of the APIVersion field in the declarative configuration.

func (*AlertmanagerConfigApplyConfiguration) GetKind added in v0.86.0

GetKind retrieves the value of the Kind field in the declarative configuration.

func (*AlertmanagerConfigApplyConfiguration) GetName added in v0.77.0

GetName retrieves the value of the Name field in the declarative configuration.

func (*AlertmanagerConfigApplyConfiguration) GetNamespace added in v0.86.0

func (b *AlertmanagerConfigApplyConfiguration) GetNamespace() *string

GetNamespace retrieves the value of the Namespace field in the declarative configuration.

func (AlertmanagerConfigApplyConfiguration) IsApplyConfiguration added in v0.86.0

func (b AlertmanagerConfigApplyConfiguration) IsApplyConfiguration()

func (*AlertmanagerConfigApplyConfiguration) WithAPIVersion

WithAPIVersion sets the APIVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIVersion field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithAnnotations

WithAnnotations puts the entries into the Annotations field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Annotations field, overwriting an existing map entries in Annotations field with the same key.

func (*AlertmanagerConfigApplyConfiguration) WithCreationTimestamp

WithCreationTimestamp sets the CreationTimestamp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CreationTimestamp field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithDeletionGracePeriodSeconds

func (b *AlertmanagerConfigApplyConfiguration) WithDeletionGracePeriodSeconds(value int64) *AlertmanagerConfigApplyConfiguration

WithDeletionGracePeriodSeconds sets the DeletionGracePeriodSeconds field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DeletionGracePeriodSeconds field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithDeletionTimestamp

WithDeletionTimestamp sets the DeletionTimestamp field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DeletionTimestamp field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithFinalizers

WithFinalizers adds the given value to the Finalizers field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Finalizers field.

func (*AlertmanagerConfigApplyConfiguration) WithGenerateName

WithGenerateName sets the GenerateName field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the GenerateName field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithGeneration

WithGeneration sets the Generation field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Generation field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithKind

WithKind sets the Kind field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Kind field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithLabels

WithLabels puts the entries into the Labels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Labels field, overwriting an existing map entries in Labels field with the same key.

func (*AlertmanagerConfigApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithNamespace

WithNamespace sets the Namespace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Namespace field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithOwnerReferences

WithOwnerReferences adds the given value to the OwnerReferences field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the OwnerReferences field.

func (*AlertmanagerConfigApplyConfiguration) WithResourceVersion

WithResourceVersion sets the ResourceVersion field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ResourceVersion field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithSpec

WithSpec sets the Spec field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Spec field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithStatus added in v0.88.0

WithStatus sets the Status field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Status field is set to the value of the last call.

func (*AlertmanagerConfigApplyConfiguration) WithUID

WithUID sets the UID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UID field is set to the value of the last call.

type AlertmanagerConfigSpecApplyConfiguration

type AlertmanagerConfigSpecApplyConfiguration struct {
	// route defines the Alertmanager route definition for incoming alerts. It will be added to the
	// generated Alertmanager configuration as a first-level route. The matching behavior of the
	// route depends on the Alertmanager's AlertmanagerConfigMatcherStrategyType.
	Route *RouteApplyConfiguration `json:"route,omitempty"`
	// receivers defines the list of receivers.
	Receivers []ReceiverApplyConfiguration `json:"receivers,omitempty"`
	// inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching
	// the resource's namespace.
	InhibitRules []InhibitRuleApplyConfiguration `json:"inhibitRules,omitempty"`
	// timeIntervals defines the list of timeIntervals specifying when the routes should be muted.
	TimeIntervals []TimeIntervalApplyConfiguration `json:"timeIntervals,omitempty"`
}

AlertmanagerConfigSpecApplyConfiguration represents a declarative configuration of the AlertmanagerConfigSpec type for use with apply.

AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the `namespace` label is equal to the namespace of the AlertmanagerConfig resource.

func AlertmanagerConfigSpec

func AlertmanagerConfigSpec() *AlertmanagerConfigSpecApplyConfiguration

AlertmanagerConfigSpecApplyConfiguration constructs a declarative configuration of the AlertmanagerConfigSpec type for use with apply.

func (*AlertmanagerConfigSpecApplyConfiguration) WithInhibitRules

WithInhibitRules adds the given value to the InhibitRules field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the InhibitRules field.

func (*AlertmanagerConfigSpecApplyConfiguration) WithReceivers

WithReceivers adds the given value to the Receivers field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Receivers field.

func (*AlertmanagerConfigSpecApplyConfiguration) WithRoute

WithRoute sets the Route field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Route field is set to the value of the last call.

func (*AlertmanagerConfigSpecApplyConfiguration) WithTimeIntervals

WithTimeIntervals adds the given value to the TimeIntervals field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the TimeIntervals field.

type DayOfMonthRangeApplyConfiguration

type DayOfMonthRangeApplyConfiguration struct {
	// start of the inclusive range
	Start *int `json:"start,omitempty"`
	// end of the inclusive range
	End *int `json:"end,omitempty"`
}

DayOfMonthRangeApplyConfiguration represents a declarative configuration of the DayOfMonthRange type for use with apply.

DayOfMonthRange is an inclusive range of days of the month beginning at 1

func DayOfMonthRange

func DayOfMonthRange() *DayOfMonthRangeApplyConfiguration

DayOfMonthRangeApplyConfiguration constructs a declarative configuration of the DayOfMonthRange type for use with apply.

func (*DayOfMonthRangeApplyConfiguration) WithEnd

WithEnd sets the End field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the End field is set to the value of the last call.

func (*DayOfMonthRangeApplyConfiguration) WithStart

WithStart sets the Start field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Start field is set to the value of the last call.

type DiscordConfigApplyConfiguration added in v0.67.0

type DiscordConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiURL defines the secret's key that contains the Discord webhook URL.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	APIURL *v1.SecretKeySelector `json:"apiURL,omitempty"`
	// title defines the template of the message's title.
	Title *string `json:"title,omitempty"`
	// message defines the template of the message's body.
	Message *string `json:"message,omitempty"`
	// content defines the template of the content's body.
	Content *string `json:"content,omitempty"`
	// username defines the username of the message sender.
	Username *string `json:"username,omitempty"`
	// avatarURL defines the avatar url of the message sender.
	AvatarURL *monitoringv1beta1.URL `json:"avatarURL,omitempty"`
	// httpConfig defines HTTP client configuration.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

DiscordConfigApplyConfiguration represents a declarative configuration of the DiscordConfig type for use with apply.

DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config

func DiscordConfig added in v0.67.0

func DiscordConfig() *DiscordConfigApplyConfiguration

DiscordConfigApplyConfiguration constructs a declarative configuration of the DiscordConfig type for use with apply.

func (*DiscordConfigApplyConfiguration) WithAPIURL added in v0.67.0

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithAvatarURL added in v0.82.0

WithAvatarURL sets the AvatarURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the AvatarURL field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithContent added in v0.82.0

WithContent sets the Content field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Content field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithHTTPConfig added in v0.67.0

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithMessage added in v0.67.0

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithSendResolved added in v0.67.0

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithTitle added in v0.67.0

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

func (*DiscordConfigApplyConfiguration) WithUsername added in v0.82.0

WithUsername sets the Username field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Username field is set to the value of the last call.

type EmailConfigApplyConfiguration

type EmailConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// to defines the email address to send notifications to.
	// This is the recipient address for alert notifications.
	To *string `json:"to,omitempty"`
	// from defines the sender address for email notifications.
	// This appears as the "From" field in the email header.
	From *string `json:"from,omitempty"`
	// hello defines the hostname to identify to the SMTP server.
	// This is used in the SMTP HELO/EHLO command during the connection handshake.
	Hello *string `json:"hello,omitempty"`
	// smarthost defines the SMTP host and port through which emails are sent.
	// Format should be "hostname:port", e.g. "smtp.example.com:587".
	Smarthost *string `json:"smarthost,omitempty"`
	// authUsername defines the username to use for SMTP authentication.
	// This is used for SMTP AUTH when the server requires authentication.
	AuthUsername *string `json:"authUsername,omitempty"`
	// authPassword defines the secret's key that contains the password to use for authentication.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	AuthPassword *SecretKeySelectorApplyConfiguration `json:"authPassword,omitempty"`
	// authSecret defines the secret's key that contains the CRAM-MD5 secret.
	// This is used for CRAM-MD5 authentication mechanism.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	AuthSecret *SecretKeySelectorApplyConfiguration `json:"authSecret,omitempty"`
	// authIdentity defines the identity to use for SMTP authentication.
	// This is typically used with PLAIN authentication mechanism.
	AuthIdentity *string `json:"authIdentity,omitempty"`
	// headers defines additional email header key/value pairs.
	// These override any headers previously set by the notification implementation.
	Headers []KeyValueApplyConfiguration `json:"headers,omitempty"`
	// html defines the HTML body of the email notification.
	// This allows for rich formatting in the email content.
	HTML *string `json:"html,omitempty"`
	// text defines the plain text body of the email notification.
	// This provides a fallback for email clients that don't support HTML.
	Text *string `json:"text,omitempty"`
	// requireTLS defines the SMTP TLS requirement.
	// Note that Go does not support unencrypted connections to remote SMTP endpoints.
	RequireTLS *bool `json:"requireTLS,omitempty"`
	// tlsConfig defines the TLS configuration for SMTP connections.
	// This includes settings for certificates, CA validation, and TLS protocol options.
	TLSConfig *v1.SafeTLSConfigApplyConfiguration `json:"tlsConfig,omitempty"`
	// forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security.
	// true: force use of implicit TLS (direct TLS connection on any port)
	// false: force disable implicit TLS (use explicit TLS/STARTTLS if required)
	// nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility
	// It requires Alertmanager >= v0.31.0.
	ForceImplicitTLS *bool `json:"forceImplicitTLS,omitempty"`
	// threading defines the threading configuration for email receiver.
	// It requires Alertmanager >= v0.30.0.
	Threading *EmailThreadingConfigApplyConfiguration `json:"threading,omitempty"`
}

EmailConfigApplyConfiguration represents a declarative configuration of the EmailConfig type for use with apply.

EmailConfig configures notifications via Email.

func EmailConfig

func EmailConfig() *EmailConfigApplyConfiguration

EmailConfigApplyConfiguration constructs a declarative configuration of the EmailConfig type for use with apply.

func (*EmailConfigApplyConfiguration) WithAuthIdentity

WithAuthIdentity sets the AuthIdentity field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the AuthIdentity field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithAuthPassword

WithAuthPassword sets the AuthPassword field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the AuthPassword field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithAuthSecret

WithAuthSecret sets the AuthSecret field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the AuthSecret field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithAuthUsername

WithAuthUsername sets the AuthUsername field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the AuthUsername field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithForceImplicitTLS added in v0.90.0

func (b *EmailConfigApplyConfiguration) WithForceImplicitTLS(value bool) *EmailConfigApplyConfiguration

WithForceImplicitTLS sets the ForceImplicitTLS field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ForceImplicitTLS field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithFrom

WithFrom sets the From field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the From field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithHTML

WithHTML sets the HTML field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTML field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithHeaders

WithHeaders adds the given value to the Headers field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Headers field.

func (*EmailConfigApplyConfiguration) WithHello

WithHello sets the Hello field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Hello field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithRequireTLS

WithRequireTLS sets the RequireTLS field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the RequireTLS field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithSmarthost

WithSmarthost sets the Smarthost field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Smarthost field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithTLSConfig

WithTLSConfig sets the TLSConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TLSConfig field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithText

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithThreading added in v0.91.0

WithThreading sets the Threading field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Threading field is set to the value of the last call.

func (*EmailConfigApplyConfiguration) WithTo

WithTo sets the To field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the To field is set to the value of the last call.

type EmailThreadingConfigApplyConfiguration added in v0.91.0

type EmailThreadingConfigApplyConfiguration struct {
	// threadByDate defines what granularity of current date to thread by. Accepted values: Daily, None.
	// (None means group by alert group key, no date).
	ThreadByDate *monitoringv1beta1.ThreadByDateType `json:"threadByDate,omitempty"`
}

EmailThreadingConfigApplyConfiguration represents a declarative configuration of the EmailThreadingConfig type for use with apply.

func EmailThreadingConfig added in v0.91.0

func EmailThreadingConfig() *EmailThreadingConfigApplyConfiguration

EmailThreadingConfigApplyConfiguration constructs a declarative configuration of the EmailThreadingConfig type for use with apply.

func (*EmailThreadingConfigApplyConfiguration) WithThreadByDate added in v0.91.0

WithThreadByDate sets the ThreadByDate field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ThreadByDate field is set to the value of the last call.

type HTTPConfigApplyConfiguration

type HTTPConfigApplyConfiguration struct {
	// authorization defines the authorization header configuration for the client.
	// This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
	Authorization *v1.SafeAuthorizationApplyConfiguration `json:"authorization,omitempty"`
	// basicAuth defines the basic authentication credentials for the client.
	// This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
	BasicAuth *v1.BasicAuthApplyConfiguration `json:"basicAuth,omitempty"`
	// oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
	// This enables OAuth2 authentication flow for HTTP requests.
	OAuth2 *v1.OAuth2ApplyConfiguration `json:"oauth2,omitempty"`
	// bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client
	// for authentication.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	BearerTokenSecret *SecretKeySelectorApplyConfiguration `json:"bearerTokenSecret,omitempty"`
	// tlsConfig defines the TLS configuration for the client.
	// This includes settings for certificates, CA validation, and TLS protocol options.
	TLSConfig *v1.SafeTLSConfigApplyConfiguration `json:"tlsConfig,omitempty"`
	// proxyURL defines an optional proxy URL for HTTP requests.
	// If defined, this field takes precedence over `proxyUrl`.
	ProxyURLOriginal                 *string `json:"proxyURL,omitempty"`
	v1.ProxyConfigApplyConfiguration `json:""`
	// followRedirects defines whether HTTP requests follow HTTP 3xx redirects.
	// When true, the client will automatically follow redirect responses.
	FollowRedirects *bool `json:"followRedirects,omitempty"`
	// enableHttp2 can be used to disable HTTP2.
	EnableHTTP2 *bool `json:"enableHttp2,omitempty"`
}

HTTPConfigApplyConfiguration represents a declarative configuration of the HTTPConfig type for use with apply.

HTTPConfig defines a client HTTP configuration. See https://prometheus.io/docs/alerting/latest/configuration/#http_config

func HTTPConfig

func HTTPConfig() *HTTPConfigApplyConfiguration

HTTPConfigApplyConfiguration constructs a declarative configuration of the HTTPConfig type for use with apply.

func (*HTTPConfigApplyConfiguration) WithAuthorization

WithAuthorization sets the Authorization field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Authorization field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithBasicAuth

WithBasicAuth sets the BasicAuth field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the BasicAuth field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithBearerTokenSecret

WithBearerTokenSecret sets the BearerTokenSecret field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the BearerTokenSecret field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithEnableHTTP2 added in v0.86.0

WithEnableHTTP2 sets the EnableHTTP2 field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the EnableHTTP2 field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithFollowRedirects

func (b *HTTPConfigApplyConfiguration) WithFollowRedirects(value bool) *HTTPConfigApplyConfiguration

WithFollowRedirects sets the FollowRedirects field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the FollowRedirects field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithNoProxy added in v0.77.0

WithNoProxy sets the NoProxy field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the NoProxy field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithOAuth2

WithOAuth2 sets the OAuth2 field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the OAuth2 field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithProxyConnectHeader added in v0.77.0

WithProxyConnectHeader puts the entries into the ProxyConnectHeader field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the ProxyConnectHeader field, overwriting an existing map entries in ProxyConnectHeader field with the same key.

func (*HTTPConfigApplyConfiguration) WithProxyFromEnvironment added in v0.77.0

func (b *HTTPConfigApplyConfiguration) WithProxyFromEnvironment(value bool) *HTTPConfigApplyConfiguration

WithProxyFromEnvironment sets the ProxyFromEnvironment field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ProxyFromEnvironment field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithProxyURL

WithProxyURL sets the ProxyURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ProxyURL field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithProxyURLOriginal added in v0.78.2

func (b *HTTPConfigApplyConfiguration) WithProxyURLOriginal(value string) *HTTPConfigApplyConfiguration

WithProxyURLOriginal sets the ProxyURLOriginal field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ProxyURLOriginal field is set to the value of the last call.

func (*HTTPConfigApplyConfiguration) WithTLSConfig

WithTLSConfig sets the TLSConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TLSConfig field is set to the value of the last call.

type InhibitRuleApplyConfiguration

type InhibitRuleApplyConfiguration struct {
	// targetMatch defines matchers that have to be fulfilled in the alerts to be muted.
	// The operator enforces that the alert matches the resource's namespace.
	// When these conditions are met, matching alerts will be inhibited (silenced).
	TargetMatch []MatcherApplyConfiguration `json:"targetMatch,omitempty"`
	// sourceMatch defines matchers for which one or more alerts have to exist for the inhibition
	// to take effect. The operator enforces that the alert matches the resource's namespace.
	// These are the "trigger" alerts that cause other alerts to be inhibited.
	SourceMatch []MatcherApplyConfiguration `json:"sourceMatch,omitempty"`
	// equal defines labels that must have an equal value in the source and target alert
	// for the inhibition to take effect. This ensures related alerts are properly grouped.
	Equal []string `json:"equal,omitempty"`
}

InhibitRuleApplyConfiguration represents a declarative configuration of the InhibitRule type for use with apply.

InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule

func InhibitRule

func InhibitRule() *InhibitRuleApplyConfiguration

InhibitRuleApplyConfiguration constructs a declarative configuration of the InhibitRule type for use with apply.

func (*InhibitRuleApplyConfiguration) WithEqual

WithEqual adds the given value to the Equal field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Equal field.

func (*InhibitRuleApplyConfiguration) WithSourceMatch

WithSourceMatch adds the given value to the SourceMatch field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the SourceMatch field.

func (*InhibitRuleApplyConfiguration) WithTargetMatch

WithTargetMatch adds the given value to the TargetMatch field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the TargetMatch field.

type KeyValueApplyConfiguration

type KeyValueApplyConfiguration struct {
	// key defines the key of the tuple.
	// This is the identifier or name part of the key-value pair.
	Key *string `json:"key,omitempty"`
	// value defines the value of the tuple.
	// This is the data or content associated with the key.
	Value *string `json:"value,omitempty"`
}

KeyValueApplyConfiguration represents a declarative configuration of the KeyValue type for use with apply.

KeyValue defines a (key, value) tuple.

func KeyValue

func KeyValue() *KeyValueApplyConfiguration

KeyValueApplyConfiguration constructs a declarative configuration of the KeyValue type for use with apply.

func (*KeyValueApplyConfiguration) WithKey

WithKey sets the Key field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Key field is set to the value of the last call.

func (*KeyValueApplyConfiguration) WithValue

WithValue sets the Value field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Value field is set to the value of the last call.

type MSTeamsConfigApplyConfiguration added in v0.69.0

type MSTeamsConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// webhookUrl defines the MSTeams webhook URL for sending notifications.
	// This is the incoming webhook URL configured in your Teams channel.
	WebhookURL *v1.SecretKeySelector `json:"webhookUrl,omitempty"`
	// title defines the message title template for Teams notifications.
	// This appears as the main heading of the Teams message card.
	Title *string `json:"title,omitempty"`
	// summary defines the message summary template for Teams notifications.
	// This provides a brief overview that appears in Teams notification previews.
	// It requires Alertmanager >= 0.27.0.
	Summary *string `json:"summary,omitempty"`
	// text defines the message body template for Teams notifications.
	// This contains the detailed content of the Teams message.
	Text *string `json:"text,omitempty"`
	// httpConfig defines the HTTP client configuration for Teams webhook requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

MSTeamsConfigApplyConfiguration represents a declarative configuration of the MSTeamsConfig type for use with apply.

MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.

func MSTeamsConfig added in v0.69.0

func MSTeamsConfig() *MSTeamsConfigApplyConfiguration

MSTeamsConfigApplyConfiguration constructs a declarative configuration of the MSTeamsConfig type for use with apply.

func (*MSTeamsConfigApplyConfiguration) WithHTTPConfig added in v0.69.0

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*MSTeamsConfigApplyConfiguration) WithSendResolved added in v0.69.0

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*MSTeamsConfigApplyConfiguration) WithSummary added in v0.73.0

WithSummary sets the Summary field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Summary field is set to the value of the last call.

func (*MSTeamsConfigApplyConfiguration) WithText added in v0.69.0

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*MSTeamsConfigApplyConfiguration) WithTitle added in v0.69.0

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

func (*MSTeamsConfigApplyConfiguration) WithWebhookURL added in v0.69.0

WithWebhookURL sets the WebhookURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the WebhookURL field is set to the value of the last call.

type MSTeamsV2ConfigApplyConfiguration added in v0.82.0

type MSTeamsV2ConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications.
	// This webhook must support the newer adaptive cards format required by Teams flows.
	WebhookURL *v1.SecretKeySelector `json:"webhookURL,omitempty"`
	// title defines the message title template for adaptive card notifications.
	// This appears as the main heading in the Teams adaptive card.
	Title *string `json:"title,omitempty"`
	// text defines the message body template for adaptive card notifications.
	// This contains the detailed content displayed in the Teams adaptive card format.
	Text *string `json:"text,omitempty"`
	// httpConfig defines the HTTP client configuration for Teams webhook requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

MSTeamsV2ConfigApplyConfiguration represents a declarative configuration of the MSTeamsV2Config type for use with apply.

MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.

func MSTeamsV2Config added in v0.82.0

func MSTeamsV2Config() *MSTeamsV2ConfigApplyConfiguration

MSTeamsV2ConfigApplyConfiguration constructs a declarative configuration of the MSTeamsV2Config type for use with apply.

func (*MSTeamsV2ConfigApplyConfiguration) WithHTTPConfig added in v0.82.0

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*MSTeamsV2ConfigApplyConfiguration) WithSendResolved added in v0.82.0

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*MSTeamsV2ConfigApplyConfiguration) WithText added in v0.82.0

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*MSTeamsV2ConfigApplyConfiguration) WithTitle added in v0.82.0

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

func (*MSTeamsV2ConfigApplyConfiguration) WithWebhookURL added in v0.82.0

WithWebhookURL sets the WebhookURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the WebhookURL field is set to the value of the last call.

type MatcherApplyConfiguration

type MatcherApplyConfiguration struct {
	// name defines the label to match.
	// This specifies which alert label should be evaluated.
	Name *string `json:"name,omitempty"`
	// value defines the label value to match.
	// This is the expected value for the specified label.
	Value *string `json:"value,omitempty"`
	// matchType defines the match operation available with AlertManager >= v0.22.0.
	// Takes precedence over Regex (deprecated) if non-empty.
	// Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).
	MatchType *monitoringv1beta1.MatchType `json:"matchType,omitempty"`
}

MatcherApplyConfiguration represents a declarative configuration of the Matcher type for use with apply.

Matcher defines how to match on alert's labels.

func Matcher

func Matcher() *MatcherApplyConfiguration

MatcherApplyConfiguration constructs a declarative configuration of the Matcher type for use with apply.

func (*MatcherApplyConfiguration) WithMatchType

WithMatchType sets the MatchType field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MatchType field is set to the value of the last call.

func (*MatcherApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*MatcherApplyConfiguration) WithValue

WithValue sets the Value field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Value field is set to the value of the last call.

type OpsGenieConfigApplyConfiguration

type OpsGenieConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiKey defines the secret's key that contains the OpsGenie API key.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	APIKey *SecretKeySelectorApplyConfiguration `json:"apiKey,omitempty"`
	// apiURL defines the URL to send OpsGenie API requests to.
	// When not specified, defaults to the standard OpsGenie API endpoint.
	APIURL *monitoringv1beta1.URL `json:"apiURL,omitempty"`
	// message defines the alert text limited to 130 characters.
	// This appears as the main alert title in OpsGenie.
	Message *string `json:"message,omitempty"`
	// description defines the detailed description of the incident.
	// This provides additional context beyond the message field.
	Description *string `json:"description,omitempty"`
	// source defines the backlink to the sender of the notification.
	// This helps identify where the alert originated from.
	Source *string `json:"source,omitempty"`
	// tags defines a comma separated list of tags attached to the notifications.
	// These help categorize and filter alerts within OpsGenie.
	Tags *string `json:"tags,omitempty"`
	// note defines an additional alert note.
	// This provides supplementary information about the alert.
	Note *string `json:"note,omitempty"`
	// priority defines the priority level of alert.
	// Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority.
	Priority *string `json:"priority,omitempty"`
	// details defines a set of arbitrary key/value pairs that provide further detail about the incident.
	// These appear as additional fields in the OpsGenie alert.
	Details []KeyValueApplyConfiguration `json:"details,omitempty"`
	// responders defines the list of responders responsible for notifications.
	// These determine who gets notified when the alert is created.
	Responders []OpsGenieConfigResponderApplyConfiguration `json:"responders,omitempty"`
	// httpConfig defines the HTTP client configuration for OpsGenie API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
	// entity defines an optional field that can be used to specify which domain alert is related to.
	// This helps group related alerts together in OpsGenie.
	Entity *string `json:"entity,omitempty"`
	// actions defines a comma separated list of actions that will be available for the alert.
	// These appear as action buttons in the OpsGenie interface.
	Actions *string `json:"actions,omitempty"`
}

OpsGenieConfigApplyConfiguration represents a declarative configuration of the OpsGenieConfig type for use with apply.

OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

func OpsGenieConfig

func OpsGenieConfig() *OpsGenieConfigApplyConfiguration

OpsGenieConfigApplyConfiguration constructs a declarative configuration of the OpsGenieConfig type for use with apply.

func (*OpsGenieConfigApplyConfiguration) WithAPIKey

WithAPIKey sets the APIKey field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIKey field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithAPIURL

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithActions

WithActions sets the Actions field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Actions field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithDescription

WithDescription sets the Description field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Description field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithDetails

WithDetails adds the given value to the Details field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Details field.

func (*OpsGenieConfigApplyConfiguration) WithEntity

WithEntity sets the Entity field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Entity field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithMessage

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithNote

WithNote sets the Note field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Note field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithPriority

WithPriority sets the Priority field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Priority field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithResponders

WithResponders adds the given value to the Responders field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Responders field.

func (*OpsGenieConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithSource

WithSource sets the Source field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Source field is set to the value of the last call.

func (*OpsGenieConfigApplyConfiguration) WithTags

WithTags sets the Tags field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Tags field is set to the value of the last call.

type OpsGenieConfigResponderApplyConfiguration

type OpsGenieConfigResponderApplyConfiguration struct {
	// id defines the unique identifier of the responder.
	// This corresponds to the responder's ID within OpsGenie.
	ID *string `json:"id,omitempty"`
	// name defines the display name of the responder.
	// This is used when the responder is identified by name rather than ID.
	Name *string `json:"name,omitempty"`
	// username defines the username of the responder.
	// This is typically used for user-type responders when identifying by username.
	Username *string `json:"username,omitempty"`
	// type defines the type of responder.
	// Valid values include "user", "team", "schedule", and "escalation".
	// This determines how OpsGenie interprets the other identifier fields.
	Type *string `json:"type,omitempty"`
}

OpsGenieConfigResponderApplyConfiguration represents a declarative configuration of the OpsGenieConfigResponder type for use with apply.

OpsGenieConfigResponder defines a responder to an incident. One of `id`, `name` or `username` has to be defined.

func OpsGenieConfigResponder

func OpsGenieConfigResponder() *OpsGenieConfigResponderApplyConfiguration

OpsGenieConfigResponderApplyConfiguration constructs a declarative configuration of the OpsGenieConfigResponder type for use with apply.

func (*OpsGenieConfigResponderApplyConfiguration) WithID

WithID sets the ID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ID field is set to the value of the last call.

func (*OpsGenieConfigResponderApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*OpsGenieConfigResponderApplyConfiguration) WithType

WithType sets the Type field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Type field is set to the value of the last call.

func (*OpsGenieConfigResponderApplyConfiguration) WithUsername

WithUsername sets the Username field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Username field is set to the value of the last call.

type PagerDutyConfigApplyConfiguration

type PagerDutyConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// routingKey defines the secret's key that contains the PagerDuty integration key (when using
	// Events API v2). Either this field or `serviceKey` needs to be defined.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	RoutingKey *SecretKeySelectorApplyConfiguration `json:"routingKey,omitempty"`
	// serviceKey defines the secret's key that contains the PagerDuty service key (when using
	// integration type "Prometheus"). Either this field or `routingKey` needs to
	// be defined.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	ServiceKey *SecretKeySelectorApplyConfiguration `json:"serviceKey,omitempty"`
	// url defines the URL to send requests to.
	URL *monitoringv1beta1.URL `json:"url,omitempty"`
	// client defines the client identification.
	Client *string `json:"client,omitempty"`
	// clientURL defines the backlink to the sender of notification.
	ClientURL *string `json:"clientURL,omitempty"`
	// description of the incident.
	Description *string `json:"description,omitempty"`
	// severity of the incident.
	Severity *string `json:"severity,omitempty"`
	// class defines the class/type of the event.
	Class *string `json:"class,omitempty"`
	// group defines a cluster or grouping of sources.
	Group *string `json:"group,omitempty"`
	// component defines the part or component of the affected system that is broken.
	Component *string `json:"component,omitempty"`
	// details defines the arbitrary key/value pairs that provide further detail about the incident.
	Details []KeyValueApplyConfiguration `json:"details,omitempty"`
	// pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
	PagerDutyImageConfigs []PagerDutyImageConfigApplyConfiguration `json:"pagerDutyImageConfigs,omitempty"`
	// pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
	PagerDutyLinkConfigs []PagerDutyLinkConfigApplyConfiguration `json:"pagerDutyLinkConfigs,omitempty"`
	// httpConfig defines the HTTP client configuration.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
	// source defines the unique location of the affected system.
	Source *string `json:"source,omitempty"`
	// timeout is the maximum time allowed to invoke the pagerduty
	// It requires Alertmanager >= v0.30.0.
	Timeout *v1.Duration `json:"timeout,omitempty"`
}

PagerDutyConfigApplyConfiguration represents a declarative configuration of the PagerDutyConfig type for use with apply.

PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

func PagerDutyConfig

func PagerDutyConfig() *PagerDutyConfigApplyConfiguration

PagerDutyConfigApplyConfiguration constructs a declarative configuration of the PagerDutyConfig type for use with apply.

func (*PagerDutyConfigApplyConfiguration) WithClass

WithClass sets the Class field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Class field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithClient

WithClient sets the Client field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Client field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithClientURL

WithClientURL sets the ClientURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ClientURL field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithComponent

WithComponent sets the Component field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Component field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithDescription

WithDescription sets the Description field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Description field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithDetails

WithDetails adds the given value to the Details field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Details field.

func (*PagerDutyConfigApplyConfiguration) WithGroup

WithGroup sets the Group field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Group field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithPagerDutyImageConfigs

WithPagerDutyImageConfigs adds the given value to the PagerDutyImageConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the PagerDutyImageConfigs field.

func (*PagerDutyConfigApplyConfiguration) WithPagerDutyLinkConfigs

WithPagerDutyLinkConfigs adds the given value to the PagerDutyLinkConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the PagerDutyLinkConfigs field.

func (*PagerDutyConfigApplyConfiguration) WithRoutingKey

WithRoutingKey sets the RoutingKey field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the RoutingKey field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithServiceKey

WithServiceKey sets the ServiceKey field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ServiceKey field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithSeverity

WithSeverity sets the Severity field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Severity field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithSource added in v0.75.0

WithSource sets the Source field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Source field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithTimeout added in v0.88.0

WithTimeout sets the Timeout field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Timeout field is set to the value of the last call.

func (*PagerDutyConfigApplyConfiguration) WithURL

WithURL sets the URL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URL field is set to the value of the last call.

type PagerDutyImageConfigApplyConfiguration

type PagerDutyImageConfigApplyConfiguration struct {
	// src of the image being attached to the incident
	Src *string `json:"src,omitempty"`
	// href defines the optional URL; makes the image a clickable link.
	Href *string `json:"href,omitempty"`
	// alt is the optional alternative text for the image.
	Alt *string `json:"alt,omitempty"`
}

PagerDutyImageConfigApplyConfiguration represents a declarative configuration of the PagerDutyImageConfig type for use with apply.

PagerDutyImageConfig attaches images to an incident

func PagerDutyImageConfig

func PagerDutyImageConfig() *PagerDutyImageConfigApplyConfiguration

PagerDutyImageConfigApplyConfiguration constructs a declarative configuration of the PagerDutyImageConfig type for use with apply.

func (*PagerDutyImageConfigApplyConfiguration) WithAlt

WithAlt sets the Alt field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Alt field is set to the value of the last call.

func (*PagerDutyImageConfigApplyConfiguration) WithHref

WithHref sets the Href field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Href field is set to the value of the last call.

func (*PagerDutyImageConfigApplyConfiguration) WithSrc

WithSrc sets the Src field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Src field is set to the value of the last call.

type PagerDutyLinkConfigApplyConfiguration

type PagerDutyLinkConfigApplyConfiguration struct {
	// href defines the URL of the link to be attached
	Href *string `json:"href,omitempty"`
	// alt defines the text that describes the purpose of the link, and can be used as the link's text.
	Text *string `json:"alt,omitempty"`
}

PagerDutyLinkConfigApplyConfiguration represents a declarative configuration of the PagerDutyLinkConfig type for use with apply.

PagerDutyLinkConfig attaches text links to an incident

func PagerDutyLinkConfig

func PagerDutyLinkConfig() *PagerDutyLinkConfigApplyConfiguration

PagerDutyLinkConfigApplyConfiguration constructs a declarative configuration of the PagerDutyLinkConfig type for use with apply.

func (*PagerDutyLinkConfigApplyConfiguration) WithHref

WithHref sets the Href field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Href field is set to the value of the last call.

func (*PagerDutyLinkConfigApplyConfiguration) WithText

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

type PushoverConfigApplyConfiguration

type PushoverConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// userKey defines the secret's key that contains the recipient user's user key.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	// Either `userKey` or `userKeyFile` is required.
	UserKey *SecretKeySelectorApplyConfiguration `json:"userKey,omitempty"`
	// userKeyFile defines the user key file that contains the recipient user's user key.
	// Either `userKey` or `userKeyFile` is required.
	// It requires Alertmanager >= v0.26.0.
	UserKeyFile *string `json:"userKeyFile,omitempty"`
	// token defines the secret's key that contains the registered application's API token.
	// See https://pushover.net/apps for application registration.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	// Either `token` or `tokenFile` is required.
	Token *SecretKeySelectorApplyConfiguration `json:"token,omitempty"`
	// tokenFile defines the token file that contains the registered application's API token.
	// See https://pushover.net/apps for application registration.
	// Either `token` or `tokenFile` is required.
	// It requires Alertmanager >= v0.26.0.
	TokenFile *string `json:"tokenFile,omitempty"`
	// title defines the notification title displayed in the Pushover message.
	// This appears as the bold header text in the notification.
	Title *string `json:"title,omitempty"`
	// message defines the notification message content.
	// This is the main body text of the Pushover notification.
	Message *string `json:"message,omitempty"`
	// url defines a supplementary URL shown alongside the message.
	// This creates a clickable link within the Pushover notification.
	URL *string `json:"url,omitempty"`
	// urlTitle defines a title for the supplementary URL.
	// If not specified, the raw URL is shown instead.
	URLTitle *string `json:"urlTitle,omitempty"`
	// ttl defines the time to live for the alert notification.
	// This determines how long the notification remains active before expiring.
	TTL *v1.Duration `json:"ttl,omitempty"`
	// device defines the name of a specific device to send the notification to.
	// If not specified, the notification is sent to all user's devices.
	Device *string `json:"device,omitempty"`
	// sound defines the name of one of the sounds supported by device clients.
	// This overrides the user's default sound choice for this notification.
	Sound *string `json:"sound,omitempty"`
	// priority defines the notification priority level.
	// See https://pushover.net/api#priority for valid values and behavior.
	Priority *string `json:"priority,omitempty"`
	// retry defines how often the Pushover servers will send the same notification to the user.
	// Must be at least 30 seconds. Only applies to priority 2 notifications.
	Retry *string `json:"retry,omitempty"`
	// expire defines how long your notification will continue to be retried for,
	// unless the user acknowledges the notification. Only applies to priority 2 notifications.
	Expire *string `json:"expire,omitempty"`
	// html defines whether notification message is HTML or plain text.
	// When true, the message can include HTML formatting tags.
	// html and monospace formatting are mutually exclusive.
	HTML *bool `json:"html,omitempty"`
	// monospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html
	// html and monospace formatting are mutually exclusive.
	Monospace *bool `json:"monospace,omitempty"`
	// httpConfig defines the HTTP client configuration for Pushover API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

PushoverConfigApplyConfiguration represents a declarative configuration of the PushoverConfig type for use with apply.

PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

func PushoverConfig

func PushoverConfig() *PushoverConfigApplyConfiguration

PushoverConfigApplyConfiguration constructs a declarative configuration of the PushoverConfig type for use with apply.

func (*PushoverConfigApplyConfiguration) WithDevice added in v0.70.0

WithDevice sets the Device field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Device field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithExpire

WithExpire sets the Expire field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Expire field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithHTML

WithHTML sets the HTML field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTML field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithMessage

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithMonospace added in v0.87.0

WithMonospace sets the Monospace field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Monospace field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithPriority

WithPriority sets the Priority field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Priority field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithRetry

WithRetry sets the Retry field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Retry field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithSound

WithSound sets the Sound field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Sound field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithTTL added in v0.75.0

WithTTL sets the TTL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TTL field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithTitle

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithToken

WithToken sets the Token field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Token field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithTokenFile added in v0.69.0

WithTokenFile sets the TokenFile field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TokenFile field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithURL

WithURL sets the URL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URL field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithURLTitle

WithURLTitle sets the URLTitle field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URLTitle field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithUserKey

WithUserKey sets the UserKey field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UserKey field is set to the value of the last call.

func (*PushoverConfigApplyConfiguration) WithUserKeyFile added in v0.69.0

WithUserKeyFile sets the UserKeyFile field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UserKeyFile field is set to the value of the last call.

type ReceiverApplyConfiguration

type ReceiverApplyConfiguration struct {
	// name defines the name of the receiver. Must be unique across all items from the list.
	Name *string `json:"name,omitempty"`
	// opsgenieConfigs defines the list of OpsGenie configurations.
	OpsGenieConfigs []OpsGenieConfigApplyConfiguration `json:"opsgenieConfigs,omitempty"`
	// pagerdutyConfigs defines the List of PagerDuty configurations.
	PagerDutyConfigs []PagerDutyConfigApplyConfiguration `json:"pagerdutyConfigs,omitempty"`
	// discordConfigs defines the list of Discord configurations.
	DiscordConfigs []DiscordConfigApplyConfiguration `json:"discordConfigs,omitempty"`
	// slackConfigs defines the list of Slack configurations.
	SlackConfigs []SlackConfigApplyConfiguration `json:"slackConfigs,omitempty"`
	// webhookConfigs defines the List of webhook configurations.
	WebhookConfigs []WebhookConfigApplyConfiguration `json:"webhookConfigs,omitempty"`
	// wechatConfigs defines the list of WeChat configurations.
	WeChatConfigs []WeChatConfigApplyConfiguration `json:"wechatConfigs,omitempty"`
	// emailConfigs defines the list of Email configurations.
	EmailConfigs []EmailConfigApplyConfiguration `json:"emailConfigs,omitempty"`
	// victoropsConfigs defines the list of VictorOps configurations.
	VictorOpsConfigs []VictorOpsConfigApplyConfiguration `json:"victoropsConfigs,omitempty"`
	// pushoverConfigs defines the list of Pushover configurations.
	PushoverConfigs []PushoverConfigApplyConfiguration `json:"pushoverConfigs,omitempty"`
	// snsConfigs defines the list of SNS configurations
	SNSConfigs []SNSConfigApplyConfiguration `json:"snsConfigs,omitempty"`
	// telegramConfigs defines the list of Telegram configurations.
	TelegramConfigs []TelegramConfigApplyConfiguration `json:"telegramConfigs,omitempty"`
	// webexConfigs defines the list of Webex configurations.
	WebexConfigs []WebexConfigApplyConfiguration `json:"webexConfigs,omitempty"`
	// msteamsConfigs defines the list of MSTeams configurations.
	// It requires Alertmanager >= 0.26.0.
	MSTeamsConfigs []MSTeamsConfigApplyConfiguration `json:"msteamsConfigs,omitempty"`
	// msteamsv2Configs defines the list of MSTeamsV2 configurations.
	// It requires Alertmanager >= 0.28.0.
	MSTeamsV2Configs []MSTeamsV2ConfigApplyConfiguration `json:"msteamsv2Configs,omitempty"`
	// rocketchatConfigs defines the list of RocketChat configurations.
	// It requires Alertmanager >= 0.28.0.
	RocketChatConfigs []RocketChatConfigApplyConfiguration `json:"rocketchatConfigs,omitempty"`
}

ReceiverApplyConfiguration represents a declarative configuration of the Receiver type for use with apply.

Receiver defines one or more notification integrations.

func Receiver

func Receiver() *ReceiverApplyConfiguration

ReceiverApplyConfiguration constructs a declarative configuration of the Receiver type for use with apply.

func (*ReceiverApplyConfiguration) WithDiscordConfigs added in v0.67.0

WithDiscordConfigs adds the given value to the DiscordConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the DiscordConfigs field.

func (*ReceiverApplyConfiguration) WithEmailConfigs

WithEmailConfigs adds the given value to the EmailConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the EmailConfigs field.

func (*ReceiverApplyConfiguration) WithMSTeamsConfigs added in v0.69.0

WithMSTeamsConfigs adds the given value to the MSTeamsConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the MSTeamsConfigs field.

func (*ReceiverApplyConfiguration) WithMSTeamsV2Configs added in v0.82.0

WithMSTeamsV2Configs adds the given value to the MSTeamsV2Configs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the MSTeamsV2Configs field.

func (*ReceiverApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*ReceiverApplyConfiguration) WithOpsGenieConfigs

WithOpsGenieConfigs adds the given value to the OpsGenieConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the OpsGenieConfigs field.

func (*ReceiverApplyConfiguration) WithPagerDutyConfigs

WithPagerDutyConfigs adds the given value to the PagerDutyConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the PagerDutyConfigs field.

func (*ReceiverApplyConfiguration) WithPushoverConfigs

WithPushoverConfigs adds the given value to the PushoverConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the PushoverConfigs field.

func (*ReceiverApplyConfiguration) WithRocketChatConfigs added in v0.85.0

WithRocketChatConfigs adds the given value to the RocketChatConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the RocketChatConfigs field.

func (*ReceiverApplyConfiguration) WithSNSConfigs

WithSNSConfigs adds the given value to the SNSConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the SNSConfigs field.

func (*ReceiverApplyConfiguration) WithSlackConfigs

WithSlackConfigs adds the given value to the SlackConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the SlackConfigs field.

func (*ReceiverApplyConfiguration) WithTelegramConfigs

WithTelegramConfigs adds the given value to the TelegramConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the TelegramConfigs field.

func (*ReceiverApplyConfiguration) WithVictorOpsConfigs

WithVictorOpsConfigs adds the given value to the VictorOpsConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the VictorOpsConfigs field.

func (*ReceiverApplyConfiguration) WithWeChatConfigs

WithWeChatConfigs adds the given value to the WeChatConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the WeChatConfigs field.

func (*ReceiverApplyConfiguration) WithWebexConfigs added in v0.68.0

WithWebexConfigs adds the given value to the WebexConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the WebexConfigs field.

func (*ReceiverApplyConfiguration) WithWebhookConfigs

WithWebhookConfigs adds the given value to the WebhookConfigs field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the WebhookConfigs field.

type RocketChatActionConfigApplyConfiguration added in v0.85.0

type RocketChatActionConfigApplyConfiguration struct {
	// text defines the button text displayed to users.
	// This is the label that appears on the interactive button.
	Text *string `json:"text,omitempty"`
	// url defines the URL the button links to when clicked.
	// This creates a clickable button that opens the specified URL.
	URL *string `json:"url,omitempty"`
	// msg defines the message to send when the button is clicked.
	// This allows the button to post a predefined message to the channel.
	Msg *string `json:"msg,omitempty"`
}

RocketChatActionConfigApplyConfiguration represents a declarative configuration of the RocketChatActionConfig type for use with apply.

RocketChatActionConfig defines actions for RocketChat messages.

func RocketChatActionConfig added in v0.85.0

func RocketChatActionConfig() *RocketChatActionConfigApplyConfiguration

RocketChatActionConfigApplyConfiguration constructs a declarative configuration of the RocketChatActionConfig type for use with apply.

func (*RocketChatActionConfigApplyConfiguration) WithMsg added in v0.85.0

WithMsg sets the Msg field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Msg field is set to the value of the last call.

func (*RocketChatActionConfigApplyConfiguration) WithText added in v0.85.0

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*RocketChatActionConfigApplyConfiguration) WithURL added in v0.85.0

WithURL sets the URL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URL field is set to the value of the last call.

type RocketChatConfigApplyConfiguration added in v0.85.0

type RocketChatConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiURL defines the API URL for RocketChat.
	// Defaults to https://open.rocket.chat/ if not specified.
	APIURL *monitoringv1beta1.URL `json:"apiURL,omitempty"`
	// channel defines the channel to send alerts to.
	// This can be a channel name (e.g., "#alerts") or a direct message recipient.
	Channel *string `json:"channel,omitempty"`
	// token defines the sender token for RocketChat authentication.
	// This is the personal access token or bot token used to authenticate API requests.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	Token *v1.SecretKeySelector `json:"token,omitempty"`
	// tokenID defines the sender token ID for RocketChat authentication.
	// This is the user ID associated with the token used for API requests.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	TokenID *v1.SecretKeySelector `json:"tokenID,omitempty"`
	// color defines the message color displayed in RocketChat.
	// This appears as a colored bar alongside the message.
	Color *string `json:"color,omitempty"`
	// emoji defines the emoji to be displayed as an avatar.
	// If provided, this emoji will be used instead of the default avatar or iconURL.
	Emoji *string `json:"emoji,omitempty"`
	// iconURL defines the icon URL for the message avatar.
	// This displays a custom image as the message sender's avatar.
	IconURL *string `json:"iconURL,omitempty"`
	// text defines the message text to send.
	// This is optional because attachments can be used instead of or alongside text.
	Text *string `json:"text,omitempty"`
	// title defines the message title displayed prominently in the message.
	// This appears as bold text at the top of the message attachment.
	Title *string `json:"title,omitempty"`
	// titleLink defines the URL that the title will link to when clicked.
	// This makes the message title clickable in the RocketChat interface.
	TitleLink *string `json:"titleLink,omitempty"`
	// fields defines additional fields for the message attachment.
	// These appear as structured key-value pairs within the message.
	Fields []RocketChatFieldConfigApplyConfiguration `json:"fields,omitempty"`
	// shortFields defines whether to use short fields in the message layout.
	// When true, fields may be displayed side by side to save space.
	ShortFields *bool `json:"shortFields,omitempty"`
	// imageURL defines the image URL to display within the message.
	// This embeds an image directly in the message attachment.
	ImageURL *string `json:"imageURL,omitempty"`
	// thumbURL defines the thumbnail URL for the message.
	// This displays a small thumbnail image alongside the message content.
	ThumbURL *string `json:"thumbURL,omitempty"`
	// linkNames defines whether to enable automatic linking of usernames and channels.
	// When true, @username and #channel references become clickable links.
	LinkNames *bool `json:"linkNames,omitempty"`
	// actions defines interactive actions to include in the message.
	// These appear as buttons that users can click to trigger responses.
	Actions []RocketChatActionConfigApplyConfiguration `json:"actions,omitempty"`
	// httpConfig defines the HTTP client configuration for RocketChat API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

RocketChatConfigApplyConfiguration represents a declarative configuration of the RocketChatConfig type for use with apply.

RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.

func RocketChatConfig added in v0.85.0

func RocketChatConfig() *RocketChatConfigApplyConfiguration

RocketChatConfigApplyConfiguration constructs a declarative configuration of the RocketChatConfig type for use with apply.

func (*RocketChatConfigApplyConfiguration) WithAPIURL added in v0.85.0

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithActions added in v0.85.0

WithActions adds the given value to the Actions field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Actions field.

func (*RocketChatConfigApplyConfiguration) WithChannel added in v0.85.0

WithChannel sets the Channel field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Channel field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithColor added in v0.85.0

WithColor sets the Color field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Color field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithEmoji added in v0.85.0

WithEmoji sets the Emoji field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Emoji field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithFields added in v0.85.0

WithFields adds the given value to the Fields field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Fields field.

func (*RocketChatConfigApplyConfiguration) WithHTTPConfig added in v0.85.0

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithIconURL added in v0.85.0

WithIconURL sets the IconURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IconURL field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithImageURL added in v0.85.0

WithImageURL sets the ImageURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ImageURL field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithLinkNames added in v0.85.0

WithLinkNames sets the LinkNames field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the LinkNames field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithSendResolved added in v0.85.0

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithShortFields added in v0.85.0

WithShortFields sets the ShortFields field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ShortFields field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithText added in v0.85.0

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithThumbURL added in v0.85.0

WithThumbURL sets the ThumbURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ThumbURL field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithTitle added in v0.85.0

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

WithTitleLink sets the TitleLink field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TitleLink field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithToken added in v0.85.0

WithToken sets the Token field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Token field is set to the value of the last call.

func (*RocketChatConfigApplyConfiguration) WithTokenID added in v0.85.0

WithTokenID sets the TokenID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TokenID field is set to the value of the last call.

type RocketChatFieldConfigApplyConfiguration added in v0.85.0

type RocketChatFieldConfigApplyConfiguration struct {
	// title defines the title of this field.
	// This appears as bold text labeling the field content.
	Title *string `json:"title,omitempty"`
	// value defines the value of this field, displayed underneath the title.
	// This contains the actual data or content for the field.
	Value *string `json:"value,omitempty"`
	// short defines whether this field should be a short field.
	// When true, the field may be displayed inline with other short fields to save space.
	Short *bool `json:"short,omitempty"`
}

RocketChatFieldConfigApplyConfiguration represents a declarative configuration of the RocketChatFieldConfig type for use with apply.

RocketChatFieldConfig defines a field for RocketChat messages.

func RocketChatFieldConfig added in v0.85.0

func RocketChatFieldConfig() *RocketChatFieldConfigApplyConfiguration

RocketChatFieldConfigApplyConfiguration constructs a declarative configuration of the RocketChatFieldConfig type for use with apply.

func (*RocketChatFieldConfigApplyConfiguration) WithShort added in v0.85.0

WithShort sets the Short field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Short field is set to the value of the last call.

func (*RocketChatFieldConfigApplyConfiguration) WithTitle added in v0.85.0

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

func (*RocketChatFieldConfigApplyConfiguration) WithValue added in v0.85.0

WithValue sets the Value field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Value field is set to the value of the last call.

type RouteApplyConfiguration

type RouteApplyConfiguration struct {
	// receiver defines the name of the receiver for this route. If not empty, it should be listed in
	// the `receivers` field.
	Receiver *string `json:"receiver,omitempty"`
	// groupBy defines the list of labels to group by.
	// Labels must not be repeated (unique list).
	// Special label "..." (aggregate by all possible labels), if provided, must be the only element in the list.
	GroupBy []string `json:"groupBy,omitempty"`
	// groupWait defines how long to wait before sending the initial notification.
	// Example: "30s"
	GroupWait *v1.NonEmptyDuration `json:"groupWait,omitempty"`
	// groupInterval defines how long to wait before sending an updated notification.
	// Must be greater than 0.
	// Example: "5m"
	GroupInterval *v1.NonEmptyDuration `json:"groupInterval,omitempty"`
	// repeatInterval defines how long to wait before repeating the last notification.
	// Must be greater than 0.
	// Example: "4h"
	RepeatInterval *v1.NonEmptyDuration `json:"repeatInterval,omitempty"`
	// matchers defines the list of matchers that the alert's labels should match. For the first
	// level route, the operator removes any existing equality and regexp
	// matcher on the `namespace` label and adds a `namespace: <object namespace>` matcher,
	// unless configured otherwise in Alertmanager's AlertmanagerConfigMatcherStrategyType.
	Matchers []MatcherApplyConfiguration `json:"matchers,omitempty"`
	// continue defines the boolean indicating whether an alert should continue matching subsequent
	// sibling nodes. It will always be overridden to true for the first-level
	// route by the Prometheus operator.
	Continue *bool `json:"continue,omitempty"`
	// routes defines the child routes.
	Routes []apiextensionsv1.JSON `json:"routes,omitempty"`
	// muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,
	MuteTimeIntervals []string `json:"muteTimeIntervals,omitempty"`
	// activeTimeIntervals is a list of TimeInterval names when this route should be active.
	ActiveTimeIntervals []string `json:"activeTimeIntervals,omitempty"`
	// labels defines the list of labels that will be attached to the alerts matching this route.
	// They can be inherited by child routes and can be overridden by child routes.
	// The values support template expressions.
	//
	// It requires Alertmanager >= 0.34.0.
	Labels []KeyValueApplyConfiguration `json:"labels,omitempty"`
}

RouteApplyConfiguration represents a declarative configuration of the Route type for use with apply.

Route defines a node in the routing tree.

func Route

func Route() *RouteApplyConfiguration

RouteApplyConfiguration constructs a declarative configuration of the Route type for use with apply.

func (*RouteApplyConfiguration) WithActiveTimeIntervals

func (b *RouteApplyConfiguration) WithActiveTimeIntervals(values ...string) *RouteApplyConfiguration

WithActiveTimeIntervals adds the given value to the ActiveTimeIntervals field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the ActiveTimeIntervals field.

func (*RouteApplyConfiguration) WithContinue

func (b *RouteApplyConfiguration) WithContinue(value bool) *RouteApplyConfiguration

WithContinue sets the Continue field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Continue field is set to the value of the last call.

func (*RouteApplyConfiguration) WithGroupBy

func (b *RouteApplyConfiguration) WithGroupBy(values ...string) *RouteApplyConfiguration

WithGroupBy adds the given value to the GroupBy field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the GroupBy field.

func (*RouteApplyConfiguration) WithGroupInterval

WithGroupInterval sets the GroupInterval field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the GroupInterval field is set to the value of the last call.

func (*RouteApplyConfiguration) WithGroupWait

WithGroupWait sets the GroupWait field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the GroupWait field is set to the value of the last call.

func (*RouteApplyConfiguration) WithLabels added in v0.95.0

WithLabels adds the given value to the Labels field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Labels field.

func (*RouteApplyConfiguration) WithMatchers

WithMatchers adds the given value to the Matchers field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Matchers field.

func (*RouteApplyConfiguration) WithMuteTimeIntervals

func (b *RouteApplyConfiguration) WithMuteTimeIntervals(values ...string) *RouteApplyConfiguration

WithMuteTimeIntervals adds the given value to the MuteTimeIntervals field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the MuteTimeIntervals field.

func (*RouteApplyConfiguration) WithReceiver

func (b *RouteApplyConfiguration) WithReceiver(value string) *RouteApplyConfiguration

WithReceiver sets the Receiver field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Receiver field is set to the value of the last call.

func (*RouteApplyConfiguration) WithRepeatInterval

WithRepeatInterval sets the RepeatInterval field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the RepeatInterval field is set to the value of the last call.

func (*RouteApplyConfiguration) WithRoutes

WithRoutes adds the given value to the Routes field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Routes field.

type SNSConfigApplyConfiguration

type SNSConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com.
	// If not specified, the SNS API URL from the SNS SDK will be used.
	ApiURL *string `json:"apiURL,omitempty"`
	// sigv4 configures AWS's Signature Verification 4 signing process to sign requests.
	// This includes AWS credentials and region configuration for authentication.
	Sigv4 *v1.Sigv4ApplyConfiguration `json:"sigv4,omitempty"`
	// topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic.
	// If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.
	TopicARN *string `json:"topicARN,omitempty"`
	// subject defines the subject line when the message is delivered to email endpoints.
	// This field is only used when sending to email subscribers of an SNS topic.
	Subject *string `json:"subject,omitempty"`
	// phoneNumber defines the phone number if message is delivered via SMS in E.164 format.
	// If you don't specify this value, you must specify a value for the TopicARN or TargetARN.
	PhoneNumber *string `json:"phoneNumber,omitempty"`
	// targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications.
	// If you don't specify this value, you must specify a value for the TopicARN or PhoneNumber.
	TargetARN *string `json:"targetARN,omitempty"`
	// message defines the message content of the SNS notification.
	// This is the actual notification text that will be sent to subscribers.
	Message *string `json:"message,omitempty"`
	// attributes defines SNS message attributes as key-value pairs.
	// These provide additional metadata that can be used for message filtering and routing.
	Attributes map[string]string `json:"attributes,omitempty"`
	// httpConfig defines the HTTP client configuration for SNS API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
	// useAWSHTTPClient forces the AWS SDK's BuildableClient instead of
	// alertmanager's tracing-wrapped HTTP client. Auto-enabled when AWS_CA_BUNDLE
	// is set; set explicitly when configuring ca_bundle via shared AWS config.
	//
	// It requires Alertmanager >= 0.33.0.
	UseAWSHTTPClient *bool `json:"useAWSHTTPClient,omitempty"`
}

SNSConfigApplyConfiguration represents a declarative configuration of the SNSConfig type for use with apply.

SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs

func SNSConfig

func SNSConfig() *SNSConfigApplyConfiguration

SNSConfigApplyConfiguration constructs a declarative configuration of the SNSConfig type for use with apply.

func (*SNSConfigApplyConfiguration) WithApiURL

WithApiURL sets the ApiURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ApiURL field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithAttributes

func (b *SNSConfigApplyConfiguration) WithAttributes(entries map[string]string) *SNSConfigApplyConfiguration

WithAttributes puts the entries into the Attributes field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, the entries provided by each call will be put on the Attributes field, overwriting an existing map entries in Attributes field with the same key.

func (*SNSConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithMessage

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithPhoneNumber

WithPhoneNumber sets the PhoneNumber field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the PhoneNumber field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithSendResolved

func (b *SNSConfigApplyConfiguration) WithSendResolved(value bool) *SNSConfigApplyConfiguration

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithSigv4

WithSigv4 sets the Sigv4 field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Sigv4 field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithSubject

WithSubject sets the Subject field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Subject field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithTargetARN

WithTargetARN sets the TargetARN field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TargetARN field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithTopicARN

WithTopicARN sets the TopicARN field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TopicARN field is set to the value of the last call.

func (*SNSConfigApplyConfiguration) WithUseAWSHTTPClient added in v0.93.0

func (b *SNSConfigApplyConfiguration) WithUseAWSHTTPClient(value bool) *SNSConfigApplyConfiguration

WithUseAWSHTTPClient sets the UseAWSHTTPClient field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UseAWSHTTPClient field is set to the value of the last call.

type SecretKeySelectorApplyConfiguration

type SecretKeySelectorApplyConfiguration struct {
	// name defines the name of the secret in the object's namespace to select from.
	Name *string `json:"name,omitempty"`
	// key defines the key of the secret to select from.  Must be a valid secret key.
	Key *string `json:"key,omitempty"`
}

SecretKeySelectorApplyConfiguration represents a declarative configuration of the SecretKeySelector type for use with apply.

SecretKeySelector selects a key of a Secret.

func SecretKeySelector

func SecretKeySelector() *SecretKeySelectorApplyConfiguration

SecretKeySelectorApplyConfiguration constructs a declarative configuration of the SecretKeySelector type for use with apply.

func (*SecretKeySelectorApplyConfiguration) WithKey

WithKey sets the Key field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Key field is set to the value of the last call.

func (*SecretKeySelectorApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

type SlackActionApplyConfiguration

type SlackActionApplyConfiguration struct {
	// type defines the type of interactive component.
	// Common values include "button" for clickable buttons and "select" for dropdown menus.
	Type *string `json:"type,omitempty"`
	// text defines the user-visible label displayed on the action element.
	// For buttons, this is the button text. For select menus, this is the placeholder text.
	Text *string `json:"text,omitempty"`
	// url defines the URL to open when the action is triggered.
	// Only applicable for button-type actions. When set, clicking the button opens this URL.
	URL *string `json:"url,omitempty"`
	// style defines the visual appearance of the action element.
	// Valid values include "default", "primary" (green), and "danger" (red).
	Style *string `json:"style,omitempty"`
	// name defines a unique identifier for the action within the message.
	// This value is sent back to your application when the action is triggered.
	Name *string `json:"name,omitempty"`
	// value defines the payload sent when the action is triggered.
	// This data is included in the callback sent to your application.
	Value *string `json:"value,omitempty"`
	// confirm defines an optional confirmation dialog that appears before the action is executed.
	// When set, users must confirm their intent before the action proceeds.
	ConfirmField *SlackConfirmationFieldApplyConfiguration `json:"confirm,omitempty"`
}

SlackActionApplyConfiguration represents a declarative configuration of the SlackAction type for use with apply.

SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.

func SlackAction

func SlackAction() *SlackActionApplyConfiguration

SlackActionApplyConfiguration constructs a declarative configuration of the SlackAction type for use with apply.

func (*SlackActionApplyConfiguration) WithConfirmField

WithConfirmField sets the ConfirmField field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ConfirmField field is set to the value of the last call.

func (*SlackActionApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*SlackActionApplyConfiguration) WithStyle

WithStyle sets the Style field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Style field is set to the value of the last call.

func (*SlackActionApplyConfiguration) WithText

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*SlackActionApplyConfiguration) WithType

WithType sets the Type field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Type field is set to the value of the last call.

func (*SlackActionApplyConfiguration) WithURL

WithURL sets the URL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URL field is set to the value of the last call.

func (*SlackActionApplyConfiguration) WithValue

WithValue sets the Value field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Value field is set to the value of the last call.

type SlackConfigApplyConfiguration

type SlackConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiURL defines the secret's key that contains the Slack webhook URL.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	APIURL *SecretKeySelectorApplyConfiguration `json:"apiURL,omitempty"`
	// channel defines the channel or user to send notifications to.
	Channel *string `json:"channel,omitempty"`
	// username defines the slack bot user name.
	Username *string `json:"username,omitempty"`
	// color defines the color of the left border of the Slack message attachment.
	// Can be a hex color code (e.g., "#ff0000") or a predefined color name.
	Color *string `json:"color,omitempty"`
	// title defines the title text displayed in the Slack message attachment.
	Title *string `json:"title,omitempty"`
	// titleLink defines the URL that the title will link to when clicked.
	TitleLink *string `json:"titleLink,omitempty"`
	// pretext defines optional text that appears above the message attachment block.
	Pretext *string `json:"pretext,omitempty"`
	// text defines the main text content of the Slack message attachment.
	Text *string `json:"text,omitempty"`
	// fields defines a list of Slack fields that are sent with each notification.
	Fields []SlackFieldApplyConfiguration `json:"fields,omitempty"`
	// shortFields determines whether fields are displayed in a compact format.
	// When true, fields are shown side by side when possible.
	ShortFields *bool `json:"shortFields,omitempty"`
	// footer defines small text displayed at the bottom of the message attachment.
	Footer *string `json:"footer,omitempty"`
	// fallback defines a plain-text summary of the attachment for clients that don't support attachments.
	Fallback *string `json:"fallback,omitempty"`
	// callbackId defines an identifier for the message used in interactive components.
	CallbackID *string `json:"callbackId,omitempty"`
	// iconEmoji defines the emoji to use as the bot's avatar (e.g., ":ghost:").
	IconEmoji *string `json:"iconEmoji,omitempty"`
	// iconURL defines the URL to an image to use as the bot's avatar.
	IconURL *string `json:"iconURL,omitempty"`
	// imageURL defines the URL to an image file that will be displayed inside the message attachment.
	ImageURL *string `json:"imageURL,omitempty"`
	// thumbURL defines the URL to an image file that will be displayed as a thumbnail
	// on the right side of the message attachment.
	ThumbURL *string `json:"thumbURL,omitempty"`
	// linkNames enables automatic linking of channel names and usernames in the message.
	// When true, @channel and @username will be converted to clickable links.
	LinkNames *bool `json:"linkNames,omitempty"`
	// mrkdwnIn defines which fields should be parsed as Slack markdown.
	// Valid values include "pretext", "text", and "fields".
	MrkdwnIn []string `json:"mrkdwnIn,omitempty"`
	// actions defines a list of Slack actions that are sent with each notification.
	Actions []SlackActionApplyConfiguration `json:"actions,omitempty"`
	// httpConfig defines the HTTP client configuration.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
	// timeout defines the maximum time to wait for a webhook request to complete,
	// before failing the request and allowing it to be retried.
	// It requires Alertmanager >= v0.30.0.
	Timeout *v1.Duration `json:"timeout,omitempty"`
	// messageText defines text content of the Slack message.
	// If set, this is sent as the top-level 'text' field in the Slack payload.
	// It requires Alertmanager >= v0.31.0.
	MessageText *string `json:"messageText,omitempty"`
	// updateMessage enables updating existing Slack messages instead of creating new ones
	// when alert state changes. Please note that Webhook URLs do not support updates.
	// It requires Alertmanager >= v0.32.0.
	UpdateMessage *bool `json:"updateMessage,omitempty"`
}

SlackConfigApplyConfiguration represents a declarative configuration of the SlackConfig type for use with apply.

SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

func SlackConfig

func SlackConfig() *SlackConfigApplyConfiguration

SlackConfigApplyConfiguration constructs a declarative configuration of the SlackConfig type for use with apply.

func (*SlackConfigApplyConfiguration) WithAPIURL

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithActions

WithActions adds the given value to the Actions field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Actions field.

func (*SlackConfigApplyConfiguration) WithCallbackID

WithCallbackID sets the CallbackID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CallbackID field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithChannel

WithChannel sets the Channel field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Channel field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithColor

WithColor sets the Color field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Color field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithFallback

WithFallback sets the Fallback field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Fallback field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithFields

WithFields adds the given value to the Fields field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Fields field.

func (*SlackConfigApplyConfiguration) WithFooter

WithFooter sets the Footer field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Footer field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithIconEmoji

WithIconEmoji sets the IconEmoji field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IconEmoji field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithIconURL

WithIconURL sets the IconURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the IconURL field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithImageURL

WithImageURL sets the ImageURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ImageURL field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithLinkNames

WithLinkNames sets the LinkNames field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the LinkNames field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithMessageText added in v0.90.0

WithMessageText sets the MessageText field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MessageText field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithMrkdwnIn

WithMrkdwnIn adds the given value to the MrkdwnIn field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the MrkdwnIn field.

func (*SlackConfigApplyConfiguration) WithPretext

WithPretext sets the Pretext field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Pretext field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithShortFields

WithShortFields sets the ShortFields field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ShortFields field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithText

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithThumbURL

WithThumbURL sets the ThumbURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ThumbURL field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithTimeout added in v0.88.0

WithTimeout sets the Timeout field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Timeout field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithTitle

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

WithTitleLink sets the TitleLink field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the TitleLink field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithUpdateMessage added in v0.93.0

WithUpdateMessage sets the UpdateMessage field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the UpdateMessage field is set to the value of the last call.

func (*SlackConfigApplyConfiguration) WithUsername

WithUsername sets the Username field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Username field is set to the value of the last call.

type SlackConfirmationFieldApplyConfiguration

type SlackConfirmationFieldApplyConfiguration struct {
	// text defines the main message displayed in the confirmation dialog.
	// This should be a clear question or statement asking the user to confirm their action.
	Text *string `json:"text,omitempty"`
	// title defines the title text displayed at the top of the confirmation dialog.
	// When not specified, a default title will be used.
	Title *string `json:"title,omitempty"`
	// okText defines the label for the confirmation button in the dialog.
	// When not specified, defaults to "Okay". This button proceeds with the action.
	OkText *string `json:"okText,omitempty"`
	// dismissText defines the label for the cancel button in the dialog.
	// When not specified, defaults to "Cancel". This button cancels the action.
	DismissText *string `json:"dismissText,omitempty"`
}

SlackConfirmationFieldApplyConfiguration represents a declarative configuration of the SlackConfirmationField type for use with apply.

SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.

func SlackConfirmationField

func SlackConfirmationField() *SlackConfirmationFieldApplyConfiguration

SlackConfirmationFieldApplyConfiguration constructs a declarative configuration of the SlackConfirmationField type for use with apply.

func (*SlackConfirmationFieldApplyConfiguration) WithDismissText

WithDismissText sets the DismissText field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DismissText field is set to the value of the last call.

func (*SlackConfirmationFieldApplyConfiguration) WithOkText

WithOkText sets the OkText field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the OkText field is set to the value of the last call.

func (*SlackConfirmationFieldApplyConfiguration) WithText

WithText sets the Text field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Text field is set to the value of the last call.

func (*SlackConfirmationFieldApplyConfiguration) WithTitle

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

type SlackFieldApplyConfiguration

type SlackFieldApplyConfiguration struct {
	// title defines the label or header text displayed for this field.
	// This appears as bold text above the field value in the Slack message.
	Title *string `json:"title,omitempty"`
	// value defines the content or data displayed for this field.
	// This appears below the title and can contain plain text or Slack markdown.
	Value *string `json:"value,omitempty"`
	// short determines whether this field can be displayed alongside other short fields.
	// When true, Slack may display this field side by side with other short fields.
	// When false or not specified, the field takes the full width of the message.
	Short *bool `json:"short,omitempty"`
}

SlackFieldApplyConfiguration represents a declarative configuration of the SlackField type for use with apply.

SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.

func SlackField

func SlackField() *SlackFieldApplyConfiguration

SlackFieldApplyConfiguration constructs a declarative configuration of the SlackField type for use with apply.

func (*SlackFieldApplyConfiguration) WithShort

WithShort sets the Short field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Short field is set to the value of the last call.

func (*SlackFieldApplyConfiguration) WithTitle

WithTitle sets the Title field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Title field is set to the value of the last call.

func (*SlackFieldApplyConfiguration) WithValue

WithValue sets the Value field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Value field is set to the value of the last call.

type TelegramConfigApplyConfiguration

type TelegramConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiURL defines the Telegram API URL, e.g. https://api.telegram.org.
	// If not specified, the default Telegram API URL will be used.
	APIURL *monitoringv1beta1.URL `json:"apiURL,omitempty"`
	// botToken defines the Telegram bot token. It is mutually exclusive with `botTokenFile`.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	// Either `botToken` or `botTokenFile` is required.
	BotToken *SecretKeySelectorApplyConfiguration `json:"botToken,omitempty"`
	// botTokenFile defines the file to read the Telegram bot token from.
	// It is mutually exclusive with `botToken`.
	// Either `botToken` or `botTokenFile` is required.
	// It requires Alertmanager >= v0.26.0.
	BotTokenFile *string `json:"botTokenFile,omitempty"`
	// chatID defines the Telegram chat ID where messages will be sent.
	// This can be a user ID, group ID, or channel ID (with @ prefix for public channels).
	ChatID *int64 `json:"chatID,omitempty"`
	// messageThreadID defines the Telegram Group Topic ID for threaded messages.
	// This allows sending messages to specific topics within Telegram groups.
	// It requires Alertmanager >= 0.26.0.
	MessageThreadID *int64 `json:"messageThreadID,omitempty"`
	// message defines the message template for the Telegram notification.
	// This is the content that will be sent to the specified chat.
	Message *string `json:"message,omitempty"`
	// disableNotifications controls whether Telegram notifications are sent silently.
	// When true, users will receive the message without notification sounds.
	DisableNotifications *bool `json:"disableNotifications,omitempty"`
	// parseMode defines the parse mode for telegram message formatting.
	// Valid values are "MarkdownV2", "Markdown", and "HTML".
	// This determines how text formatting is interpreted in the message.
	ParseMode *string `json:"parseMode,omitempty"`
	// httpConfig defines the HTTP client configuration for Telegram API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

TelegramConfigApplyConfiguration represents a declarative configuration of the TelegramConfig type for use with apply.

TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config

func TelegramConfig

func TelegramConfig() *TelegramConfigApplyConfiguration

TelegramConfigApplyConfiguration constructs a declarative configuration of the TelegramConfig type for use with apply.

func (*TelegramConfigApplyConfiguration) WithAPIURL

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithBotToken

WithBotToken sets the BotToken field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the BotToken field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithBotTokenFile added in v0.68.0

WithBotTokenFile sets the BotTokenFile field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the BotTokenFile field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithChatID

WithChatID sets the ChatID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ChatID field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithDisableNotifications

func (b *TelegramConfigApplyConfiguration) WithDisableNotifications(value bool) *TelegramConfigApplyConfiguration

WithDisableNotifications sets the DisableNotifications field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the DisableNotifications field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithMessage

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithMessageThreadID added in v0.79.0

WithMessageThreadID sets the MessageThreadID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MessageThreadID field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithParseMode

WithParseMode sets the ParseMode field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ParseMode field is set to the value of the last call.

func (*TelegramConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

type TimeIntervalApplyConfiguration

type TimeIntervalApplyConfiguration struct {
	// name of the time interval.
	Name *string `json:"name,omitempty"`
	// timeIntervals defines a list of TimePeriod.
	TimeIntervals []TimePeriodApplyConfiguration `json:"timeIntervals,omitempty"`
}

TimeIntervalApplyConfiguration represents a declarative configuration of the TimeInterval type for use with apply.

TimeInterval specifies the periods in time when notifications will be muted or active.

func TimeInterval

func TimeInterval() *TimeIntervalApplyConfiguration

TimeIntervalApplyConfiguration constructs a declarative configuration of the TimeInterval type for use with apply.

func (*TimeIntervalApplyConfiguration) WithName

WithName sets the Name field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Name field is set to the value of the last call.

func (*TimeIntervalApplyConfiguration) WithTimeIntervals

WithTimeIntervals adds the given value to the TimeIntervals field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the TimeIntervals field.

type TimePeriodApplyConfiguration

type TimePeriodApplyConfiguration struct {
	// times defines a list of TimeRange
	Times []TimeRangeApplyConfiguration `json:"times,omitempty"`
	// weekdays defines a list of WeekdayRange
	Weekdays []monitoringv1beta1.WeekdayRange `json:"weekdays,omitempty"`
	// daysOfMonth defines a list of DayOfMonthRange
	DaysOfMonth []DayOfMonthRangeApplyConfiguration `json:"daysOfMonth,omitempty"`
	// months defines a list of MonthRange
	Months []monitoringv1beta1.MonthRange `json:"months,omitempty"`
	// years defines a list of YearRange
	Years []monitoringv1beta1.YearRange `json:"years,omitempty"`
}

TimePeriodApplyConfiguration represents a declarative configuration of the TimePeriod type for use with apply.

TimePeriod describes periods of time.

func TimePeriod

func TimePeriod() *TimePeriodApplyConfiguration

TimePeriodApplyConfiguration constructs a declarative configuration of the TimePeriod type for use with apply.

func (*TimePeriodApplyConfiguration) WithDaysOfMonth

WithDaysOfMonth adds the given value to the DaysOfMonth field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the DaysOfMonth field.

func (*TimePeriodApplyConfiguration) WithMonths

WithMonths adds the given value to the Months field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Months field.

func (*TimePeriodApplyConfiguration) WithTimes

WithTimes adds the given value to the Times field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Times field.

func (*TimePeriodApplyConfiguration) WithWeekdays

WithWeekdays adds the given value to the Weekdays field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Weekdays field.

func (*TimePeriodApplyConfiguration) WithYears

WithYears adds the given value to the Years field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the Years field.

type TimeRangeApplyConfiguration

type TimeRangeApplyConfiguration struct {
	// startTime defines the start time in 24hr format.
	StartTime *monitoringv1beta1.Time `json:"startTime,omitempty"`
	// endTime defines the end time in 24hr format.
	EndTime *monitoringv1beta1.Time `json:"endTime,omitempty"`
}

TimeRangeApplyConfiguration represents a declarative configuration of the TimeRange type for use with apply.

TimeRange defines a start and end time in 24hr format

func TimeRange

func TimeRange() *TimeRangeApplyConfiguration

TimeRangeApplyConfiguration constructs a declarative configuration of the TimeRange type for use with apply.

func (*TimeRangeApplyConfiguration) WithEndTime

WithEndTime sets the EndTime field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the EndTime field is set to the value of the last call.

func (*TimeRangeApplyConfiguration) WithStartTime

WithStartTime sets the StartTime field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the StartTime field is set to the value of the last call.

type VictorOpsConfigApplyConfiguration

type VictorOpsConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiKey defines the secret's key that contains the API key to use when talking to the VictorOps API.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	APIKey *SecretKeySelectorApplyConfiguration `json:"apiKey,omitempty"`
	// apiUrl defines the VictorOps API URL.
	// When not specified, defaults to the standard VictorOps API endpoint.
	APIURL *monitoringv1beta1.URL `json:"apiUrl,omitempty"`
	// routingKey defines a key used to map the alert to a team.
	// This determines which VictorOps team will receive the alert notification.
	RoutingKey *string `json:"routingKey,omitempty"`
	// messageType describes the behavior of the alert.
	// Valid values are "CRITICAL", "WARNING", and "INFO".
	MessageType *string `json:"messageType,omitempty"`
	// entityDisplayName contains a summary of the alerted problem.
	// This appears as the main title or identifier for the incident.
	EntityDisplayName *string `json:"entityDisplayName,omitempty"`
	// stateMessage contains a long explanation of the alerted problem.
	// This provides detailed context about the incident.
	StateMessage *string `json:"stateMessage,omitempty"`
	// monitoringTool defines the monitoring tool the state message is from.
	// This helps identify the source system that generated the alert.
	MonitoringTool *string `json:"monitoringTool,omitempty"`
	// customFields defines additional custom fields for notification.
	// These provide extra metadata that will be included with the VictorOps incident.
	CustomFields []KeyValueApplyConfiguration `json:"customFields,omitempty"`
	// httpConfig defines the HTTP client's configuration for VictorOps API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

VictorOpsConfigApplyConfiguration represents a declarative configuration of the VictorOpsConfig type for use with apply.

VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

func VictorOpsConfig

func VictorOpsConfig() *VictorOpsConfigApplyConfiguration

VictorOpsConfigApplyConfiguration constructs a declarative configuration of the VictorOpsConfig type for use with apply.

func (*VictorOpsConfigApplyConfiguration) WithAPIKey

WithAPIKey sets the APIKey field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIKey field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithAPIURL

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithCustomFields

WithCustomFields adds the given value to the CustomFields field in the declarative configuration and returns the receiver, so that objects can be build by chaining "With" function invocations. If called multiple times, values provided by each call will be appended to the CustomFields field.

func (*VictorOpsConfigApplyConfiguration) WithEntityDisplayName

WithEntityDisplayName sets the EntityDisplayName field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the EntityDisplayName field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithMessageType

WithMessageType sets the MessageType field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MessageType field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithMonitoringTool

WithMonitoringTool sets the MonitoringTool field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MonitoringTool field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithRoutingKey

WithRoutingKey sets the RoutingKey field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the RoutingKey field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*VictorOpsConfigApplyConfiguration) WithStateMessage

WithStateMessage sets the StateMessage field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the StateMessage field is set to the value of the last call.

type WeChatConfigApplyConfiguration

type WeChatConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiSecret defines the secret's key that contains the WeChat API key.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	APISecret *SecretKeySelectorApplyConfiguration `json:"apiSecret,omitempty"`
	// apiURL defines the WeChat API URL.
	// When not specified, defaults to the standard WeChat Work API endpoint.
	APIURL *monitoringv1beta1.URL `json:"apiURL,omitempty"`
	// corpID defines the corp id for authentication.
	// This is the unique identifier for your WeChat Work organization.
	CorpID *string `json:"corpID,omitempty"`
	// agentID defines the application agent ID within WeChat Work.
	// This identifies which WeChat Work application will send the notifications.
	AgentID *string `json:"agentID,omitempty"`
	// toUser defines the target user(s) to receive the notification.
	// Can be a single user ID or multiple user IDs separated by '|'.
	ToUser *string `json:"toUser,omitempty"`
	// toParty defines the target department(s) to receive the notification.
	// Can be a single department ID or multiple department IDs separated by '|'.
	ToParty *string `json:"toParty,omitempty"`
	// toTag defines the target tag(s) to receive the notification.
	// Can be a single tag ID or multiple tag IDs separated by '|'.
	ToTag *string `json:"toTag,omitempty"`
	// message defines the API request data as defined by the WeChat API.
	// This contains the actual notification content to be sent.
	Message *string `json:"message,omitempty"`
	// messageType defines the type of message to send.
	// Valid values include "text", "markdown", and other WeChat Work supported message types.
	MessageType *string `json:"messageType,omitempty"`
	// httpConfig defines the HTTP client configuration for WeChat API requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
}

WeChatConfigApplyConfiguration represents a declarative configuration of the WeChatConfig type for use with apply.

WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

func WeChatConfig

func WeChatConfig() *WeChatConfigApplyConfiguration

WeChatConfigApplyConfiguration constructs a declarative configuration of the WeChatConfig type for use with apply.

func (*WeChatConfigApplyConfiguration) WithAPISecret

WithAPISecret sets the APISecret field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APISecret field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithAPIURL

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithAgentID

WithAgentID sets the AgentID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the AgentID field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithCorpID

WithCorpID sets the CorpID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the CorpID field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithMessage

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithMessageType

WithMessageType sets the MessageType field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MessageType field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithToParty

WithToParty sets the ToParty field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ToParty field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithToTag

WithToTag sets the ToTag field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ToTag field is set to the value of the last call.

func (*WeChatConfigApplyConfiguration) WithToUser

WithToUser sets the ToUser field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the ToUser field is set to the value of the last call.

type WebexConfigApplyConfiguration added in v0.68.0

type WebexConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages
	APIURL *monitoringv1beta1.URL `json:"apiURL,omitempty"`
	// httpConfig defines the HTTP client's configuration.
	// You must use this configuration to supply the bot token as part of the HTTP `Authorization` header.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
	// message defines the message template
	Message *string `json:"message,omitempty"`
	// roomID defines the ID of the Webex Teams room where to send the messages.
	RoomID *string `json:"roomID,omitempty"`
}

WebexConfigApplyConfiguration represents a declarative configuration of the WebexConfig type for use with apply.

WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config

func WebexConfig added in v0.68.0

func WebexConfig() *WebexConfigApplyConfiguration

WebexConfigApplyConfiguration constructs a declarative configuration of the WebexConfig type for use with apply.

func (*WebexConfigApplyConfiguration) WithAPIURL added in v0.68.0

WithAPIURL sets the APIURL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the APIURL field is set to the value of the last call.

func (*WebexConfigApplyConfiguration) WithHTTPConfig added in v0.68.0

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*WebexConfigApplyConfiguration) WithMessage added in v0.68.0

WithMessage sets the Message field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Message field is set to the value of the last call.

func (*WebexConfigApplyConfiguration) WithRoomID added in v0.68.0

WithRoomID sets the RoomID field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the RoomID field is set to the value of the last call.

func (*WebexConfigApplyConfiguration) WithSendResolved added in v0.68.0

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

type WebhookConfigApplyConfiguration

type WebhookConfigApplyConfiguration struct {
	// sendResolved defines whether or not to notify about resolved alerts.
	SendResolved *bool `json:"sendResolved,omitempty"`
	// url defines the URL to send HTTP POST requests to.
	// urlSecret takes precedence over url. One of urlSecret and url should be defined.
	URL *string `json:"url,omitempty"`
	// urlSecret defines the secret's key that contains the webhook URL to send HTTP requests to.
	// urlSecret takes precedence over url. One of urlSecret and url should be defined.
	// The secret needs to be in the same namespace as the AlertmanagerConfig
	// object and accessible by the Prometheus Operator.
	URLSecret *SecretKeySelectorApplyConfiguration `json:"urlSecret,omitempty"`
	// httpConfig defines the HTTP client configuration for webhook requests.
	HTTPConfig *HTTPConfigApplyConfiguration `json:"httpConfig,omitempty"`
	// maxAlerts defines the maximum number of alerts to be sent per webhook message.
	// When 0, all alerts are included in the webhook payload.
	MaxAlerts *int32 `json:"maxAlerts,omitempty"`
	// timeout defines the maximum time to wait for a webhook request to complete,
	// before failing the request and allowing it to be retried.
	// It requires Alertmanager >= v0.28.0.
	Timeout *v1.Duration `json:"timeout,omitempty"`
	// payload define custom payload to be sent to the webhook endpoint.
	// This is an advanced configuration option that allows you
	// to define a custom payload using Go templates.
	// It requires Alertmanager >= v0.32.0.
	Payload *string `json:"payload,omitempty"`
}

WebhookConfigApplyConfiguration represents a declarative configuration of the WebhookConfig type for use with apply.

WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

func WebhookConfig

func WebhookConfig() *WebhookConfigApplyConfiguration

WebhookConfigApplyConfiguration constructs a declarative configuration of the WebhookConfig type for use with apply.

func (*WebhookConfigApplyConfiguration) WithHTTPConfig

WithHTTPConfig sets the HTTPConfig field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the HTTPConfig field is set to the value of the last call.

func (*WebhookConfigApplyConfiguration) WithMaxAlerts

WithMaxAlerts sets the MaxAlerts field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the MaxAlerts field is set to the value of the last call.

func (*WebhookConfigApplyConfiguration) WithPayload added in v0.92.0

WithPayload sets the Payload field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Payload field is set to the value of the last call.

func (*WebhookConfigApplyConfiguration) WithSendResolved

WithSendResolved sets the SendResolved field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the SendResolved field is set to the value of the last call.

func (*WebhookConfigApplyConfiguration) WithTimeout added in v0.82.0

WithTimeout sets the Timeout field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the Timeout field is set to the value of the last call.

func (*WebhookConfigApplyConfiguration) WithURL

WithURL sets the URL field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URL field is set to the value of the last call.

func (*WebhookConfigApplyConfiguration) WithURLSecret

WithURLSecret sets the URLSecret field in the declarative configuration to the given value and returns the receiver, so that objects can be built by chaining "With" function invocations. If called multiple times, the URLSecret field is set to the value of the last call.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL