operator.v1beta1.vmAlertmanagerConfig

"VMAlertmanagerConfig is the Schema for the vmalertmanagerconfigs API"

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of VMAlertmanagerConfig

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"VMAlertmanagerConfigSpec defines configuration for VMAlertmanagerConfig\nit must reference only locally defined objects"

fn spec.withInhibit_rules

withInhibit_rules(inhibit_rules)

"InhibitRules will only apply for alerts matching\nthe resource's namespace."

fn spec.withInhibit_rulesMixin

withInhibit_rulesMixin(inhibit_rules)

"InhibitRules will only apply for alerts matching\nthe resource's namespace."

Note: This function appends passed data to existing values

fn spec.withReceivers

withReceivers(receivers)

"Receivers defines alert receivers"

fn spec.withReceiversMixin

withReceiversMixin(receivers)

"Receivers defines alert receivers"

Note: This function appends passed data to existing values

fn spec.withTime_intervals

withTime_intervals(time_intervals)

"TimeIntervals defines named interval for active/mute notifications interval\nSee https://prometheus.io/docs/alerting/latest/configuration/#time_interval"

fn spec.withTime_intervalsMixin

withTime_intervalsMixin(time_intervals)

"TimeIntervals defines named interval for active/mute notifications interval\nSee https://prometheus.io/docs/alerting/latest/configuration/#time_interval"

Note: This function appends passed data to existing values

obj spec.inhibit_rules

"InhibitRules will only apply for alerts matching\nthe resource's namespace."

fn spec.inhibit_rules.withEqual

withEqual(equal)

"Labels that must have an equal value in the source and target alert for\nthe inhibition to take effect."

fn spec.inhibit_rules.withEqualMixin

withEqualMixin(equal)

"Labels that must have an equal value in the source and target alert for\nthe inhibition to take effect."

Note: This function appends passed data to existing values

fn spec.inhibit_rules.withSource_matchers

withSource_matchers(source_matchers)

"SourceMatchers defines a list of matchers for which one or more alerts have\nto exist for the inhibition to take effect."

fn spec.inhibit_rules.withSource_matchersMixin

withSource_matchersMixin(source_matchers)

"SourceMatchers defines a list of matchers for which one or more alerts have\nto exist for the inhibition to take effect."

Note: This function appends passed data to existing values

fn spec.inhibit_rules.withTarget_matchers

withTarget_matchers(target_matchers)

"TargetMatchers defines a list of matchers that have to be fulfilled by the target\nalerts to be muted."

fn spec.inhibit_rules.withTarget_matchersMixin

withTarget_matchersMixin(target_matchers)

"TargetMatchers defines a list of matchers that have to be fulfilled by the target\nalerts to be muted."

Note: This function appends passed data to existing values

obj spec.receivers

"Receivers defines alert receivers"

fn spec.receivers.withDiscord_configs

withDiscord_configs(discord_configs)

fn spec.receivers.withDiscord_configsMixin

withDiscord_configsMixin(discord_configs)

Note: This function appends passed data to existing values

fn spec.receivers.withEmail_configs

withEmail_configs(email_configs)

"EmailConfigs defines email notification configurations."

fn spec.receivers.withEmail_configsMixin

withEmail_configsMixin(email_configs)

"EmailConfigs defines email notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withMsteams_configs

withMsteams_configs(msteams_configs)

fn spec.receivers.withMsteams_configsMixin

withMsteams_configsMixin(msteams_configs)

Note: This function appends passed data to existing values

fn spec.receivers.withName

withName(name)

"Name of the receiver. Must be unique across all items from the list."

fn spec.receivers.withOpsgenie_configs

withOpsgenie_configs(opsgenie_configs)

"OpsGenieConfigs defines ops genie notification configurations."

fn spec.receivers.withOpsgenie_configsMixin

withOpsgenie_configsMixin(opsgenie_configs)

"OpsGenieConfigs defines ops genie notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withPagerduty_configs

withPagerduty_configs(pagerduty_configs)

"PagerDutyConfigs defines pager duty notification configurations."

fn spec.receivers.withPagerduty_configsMixin

withPagerduty_configsMixin(pagerduty_configs)

"PagerDutyConfigs defines pager duty notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withPushover_configs

withPushover_configs(pushover_configs)

"PushoverConfigs defines push over notification configurations."

fn spec.receivers.withPushover_configsMixin

withPushover_configsMixin(pushover_configs)

"PushoverConfigs defines push over notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withSlack_configs

withSlack_configs(slack_configs)

"SlackConfigs defines slack notification configurations."

fn spec.receivers.withSlack_configsMixin

withSlack_configsMixin(slack_configs)

"SlackConfigs defines slack notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withSns_configs

withSns_configs(sns_configs)

fn spec.receivers.withSns_configsMixin

withSns_configsMixin(sns_configs)

Note: This function appends passed data to existing values

fn spec.receivers.withTelegram_configs

withTelegram_configs(telegram_configs)

fn spec.receivers.withTelegram_configsMixin

withTelegram_configsMixin(telegram_configs)

Note: This function appends passed data to existing values

fn spec.receivers.withVictorops_configs

withVictorops_configs(victorops_configs)

"VictorOpsConfigs defines victor ops notification configurations."

fn spec.receivers.withVictorops_configsMixin

withVictorops_configsMixin(victorops_configs)

"VictorOpsConfigs defines victor ops notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withWebex_configs

withWebex_configs(webex_configs)

fn spec.receivers.withWebex_configsMixin

withWebex_configsMixin(webex_configs)

Note: This function appends passed data to existing values

fn spec.receivers.withWebhook_configs

withWebhook_configs(webhook_configs)

"WebhookConfigs defines webhook notification configurations."

fn spec.receivers.withWebhook_configsMixin

withWebhook_configsMixin(webhook_configs)

"WebhookConfigs defines webhook notification configurations."

Note: This function appends passed data to existing values

fn spec.receivers.withWechat_configs

withWechat_configs(wechat_configs)

"WeChatConfigs defines wechat notification configurations."

fn spec.receivers.withWechat_configsMixin

withWechat_configsMixin(wechat_configs)

"WeChatConfigs defines wechat notification configurations."

Note: This function appends passed data to existing values

obj spec.receivers.discord_configs

fn spec.receivers.discord_configs.withMessage

withMessage(message)

"The message body template"

fn spec.receivers.discord_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.discord_configs.withTitle

withTitle(title)

"The message title template"

fn spec.receivers.discord_configs.withWebhook_url

withWebhook_url(webhook_url)

"The discord webhook URL\none of urlSecret and url must be defined."

obj spec.receivers.discord_configs.http_config

"HTTP client configuration."

fn spec.receivers.discord_configs.http_config.withBearer_token_file

withBearer_token_file(bearer_token_file)

"BearerTokenFile defines filename for bearer token, it must be mounted to pod."

fn spec.receivers.discord_configs.http_config.withProxyURL

withProxyURL(proxyURL)

"Optional proxy URL."

obj spec.receivers.discord_configs.http_config.authorization

"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."

fn spec.receivers.discord_configs.http_config.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File with value for authorization"

fn spec.receivers.discord_configs.http_config.authorization.withType

withType(type)

"Type of authorization, default to bearer"

obj spec.receivers.discord_configs.http_config.authorization.credentials

"Reference to the secret with value for authorization"

fn spec.receivers.discord_configs.http_config.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.authorization.credentials.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.basic_auth

"BasicAuth for the client."

fn spec.receivers.discord_configs.http_config.basic_auth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.receivers.discord_configs.http_config.basic_auth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.discord_configs.http_config.basic_auth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.basic_auth.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.basic_auth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.basic_auth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.discord_configs.http_config.basic_auth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.basic_auth.username.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.basic_auth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.bearer_token_secret

"The secret's key that contains the bearer token\nIt must be at them same namespace as CRD"

fn spec.receivers.discord_configs.http_config.bearer_token_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.bearer_token_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.bearer_token_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.oauth2

"OAuth2 client credentials used to fetch a token for the targets."

fn spec.receivers.discord_configs.http_config.oauth2.withClient_secret_file

withClient_secret_file(client_secret_file)

"ClientSecretFile defines path for client secret file."

fn spec.receivers.discord_configs.http_config.oauth2.withEndpoint_params

withEndpoint_params(endpoint_params)

"Parameters to append to the token URL"

fn spec.receivers.discord_configs.http_config.oauth2.withEndpoint_paramsMixin

withEndpoint_paramsMixin(endpoint_params)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.receivers.discord_configs.http_config.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.receivers.discord_configs.http_config.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.receivers.discord_configs.http_config.oauth2.withToken_url

withToken_url(token_url)

"The URL to fetch the token from"

obj spec.receivers.discord_configs.http_config.oauth2.client_id

"The secret or configmap containing the OAuth2 client id"

obj spec.receivers.discord_configs.http_config.oauth2.client_id.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.discord_configs.http_config.oauth2.client_id.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.discord_configs.http_config.oauth2.client_id.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.oauth2.client_id.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.discord_configs.http_config.oauth2.client_id.secret

"Secret containing data to use for the targets."

fn spec.receivers.discord_configs.http_config.oauth2.client_id.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.oauth2.client_id.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.oauth2.client_id.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.oauth2.client_secret

"The secret containing the OAuth2 client secret"

fn spec.receivers.discord_configs.http_config.oauth2.client_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.oauth2.client_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.oauth2.client_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.tls_config

"TLS configuration for the client."

fn spec.receivers.discord_configs.http_config.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.discord_configs.http_config.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.discord_configs.http_config.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.discord_configs.http_config.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.discord_configs.http_config.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.discord_configs.http_config.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.discord_configs.http_config.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.discord_configs.http_config.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.discord_configs.http_config.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.http_config.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.discord_configs.http_config.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.http_config.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.http_config.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.discord_configs.webhook_url_secret

"URLSecret defines secret name and key at the CRD namespace.\nIt must contain the webhook URL.\none of urlSecret and url must be defined."

fn spec.receivers.discord_configs.webhook_url_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.discord_configs.webhook_url_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.discord_configs.webhook_url_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.email_configs

"EmailConfigs defines email notification configurations."

fn spec.receivers.email_configs.withAuth_identity

withAuth_identity(auth_identity)

"The identity to use for authentication."

fn spec.receivers.email_configs.withAuth_username

withAuth_username(auth_username)

"The username to use for authentication."

fn spec.receivers.email_configs.withFrom

withFrom(from)

"The sender address.\nfallback to global setting if empty"

fn spec.receivers.email_configs.withHeaders

withHeaders(headers)

"Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation."

fn spec.receivers.email_configs.withHeadersMixin

withHeadersMixin(headers)

"Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation."

Note: This function appends passed data to existing values

fn spec.receivers.email_configs.withHello

withHello(hello)

"The hostname to identify to the SMTP server."

fn spec.receivers.email_configs.withHtml

withHtml(html)

"The HTML body of the email notification."

fn spec.receivers.email_configs.withRequire_tls

withRequire_tls(require_tls)

"The SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints."

fn spec.receivers.email_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.email_configs.withSmarthost

withSmarthost(smarthost)

"The SMTP host through which emails are sent.\nfallback to global setting if empty"

fn spec.receivers.email_configs.withText

withText(text)

"The text body of the email notification."

fn spec.receivers.email_configs.withTo

withTo(to)

"The email address to send notifications to."

obj spec.receivers.email_configs.auth_password

"AuthPassword defines secret name and key at CRD namespace."

fn spec.receivers.email_configs.auth_password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.email_configs.auth_password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.auth_password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.email_configs.auth_secret

"AuthSecret defines secrent name and key at CRD namespace.\nIt must contain the CRAM-MD5 secret."

fn spec.receivers.email_configs.auth_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.email_configs.auth_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.auth_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.email_configs.tls_config

"TLS configuration"

fn spec.receivers.email_configs.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.email_configs.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.email_configs.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.email_configs.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.email_configs.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.email_configs.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.email_configs.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.email_configs.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.email_configs.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.email_configs.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.email_configs.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.email_configs.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.email_configs.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.email_configs.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.email_configs.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.email_configs.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.email_configs.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.email_configs.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.email_configs.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.email_configs.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.email_configs.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.email_configs.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.email_configs.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs

fn spec.receivers.msteams_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.msteams_configs.withText

withText(text)

"The text body of the teams notification."

fn spec.receivers.msteams_configs.withTitle

withTitle(title)

"The title of the teams notification."

fn spec.receivers.msteams_configs.withWebhook_url

withWebhook_url(webhook_url)

"The incoming webhook URL\none of urlSecret and url must be defined."

obj spec.receivers.msteams_configs.http_config

"HTTP client configuration."

fn spec.receivers.msteams_configs.http_config.withBearer_token_file

withBearer_token_file(bearer_token_file)

"BearerTokenFile defines filename for bearer token, it must be mounted to pod."

fn spec.receivers.msteams_configs.http_config.withProxyURL

withProxyURL(proxyURL)

"Optional proxy URL."

obj spec.receivers.msteams_configs.http_config.authorization

"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."

fn spec.receivers.msteams_configs.http_config.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File with value for authorization"

fn spec.receivers.msteams_configs.http_config.authorization.withType

withType(type)

"Type of authorization, default to bearer"

obj spec.receivers.msteams_configs.http_config.authorization.credentials

"Reference to the secret with value for authorization"

fn spec.receivers.msteams_configs.http_config.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.authorization.credentials.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.basic_auth

"BasicAuth for the client."

fn spec.receivers.msteams_configs.http_config.basic_auth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.receivers.msteams_configs.http_config.basic_auth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.msteams_configs.http_config.basic_auth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.basic_auth.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.basic_auth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.basic_auth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.msteams_configs.http_config.basic_auth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.basic_auth.username.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.basic_auth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.bearer_token_secret

"The secret's key that contains the bearer token\nIt must be at them same namespace as CRD"

fn spec.receivers.msteams_configs.http_config.bearer_token_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.bearer_token_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.bearer_token_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.oauth2

"OAuth2 client credentials used to fetch a token for the targets."

fn spec.receivers.msteams_configs.http_config.oauth2.withClient_secret_file

withClient_secret_file(client_secret_file)

"ClientSecretFile defines path for client secret file."

fn spec.receivers.msteams_configs.http_config.oauth2.withEndpoint_params

withEndpoint_params(endpoint_params)

"Parameters to append to the token URL"

fn spec.receivers.msteams_configs.http_config.oauth2.withEndpoint_paramsMixin

withEndpoint_paramsMixin(endpoint_params)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.receivers.msteams_configs.http_config.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.receivers.msteams_configs.http_config.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.receivers.msteams_configs.http_config.oauth2.withToken_url

withToken_url(token_url)

"The URL to fetch the token from"

obj spec.receivers.msteams_configs.http_config.oauth2.client_id

"The secret or configmap containing the OAuth2 client id"

obj spec.receivers.msteams_configs.http_config.oauth2.client_id.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.msteams_configs.http_config.oauth2.client_id.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.msteams_configs.http_config.oauth2.client_id.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.oauth2.client_id.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.msteams_configs.http_config.oauth2.client_id.secret

"Secret containing data to use for the targets."

fn spec.receivers.msteams_configs.http_config.oauth2.client_id.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.oauth2.client_id.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.oauth2.client_id.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.oauth2.client_secret

"The secret containing the OAuth2 client secret"

fn spec.receivers.msteams_configs.http_config.oauth2.client_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.oauth2.client_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.oauth2.client_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.tls_config

"TLS configuration for the client."

fn spec.receivers.msteams_configs.http_config.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.msteams_configs.http_config.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.msteams_configs.http_config.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.msteams_configs.http_config.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.msteams_configs.http_config.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.msteams_configs.http_config.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.msteams_configs.http_config.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.msteams_configs.http_config.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.msteams_configs.http_config.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.http_config.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.msteams_configs.http_config.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.http_config.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.http_config.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.msteams_configs.webhook_url_secret

"URLSecret defines secret name and key at the CRD namespace.\nIt must contain the webhook URL.\none of urlSecret and url must be defined."

fn spec.receivers.msteams_configs.webhook_url_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.msteams_configs.webhook_url_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.msteams_configs.webhook_url_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.opsgenie_configs

"OpsGenieConfigs defines ops genie notification configurations."

fn spec.receivers.opsgenie_configs.withActions

withActions(actions)

"Comma separated list of actions that will be available for the alert."

fn spec.receivers.opsgenie_configs.withApiURL

withApiURL(apiURL)

"The URL to send OpsGenie API requests to."

fn spec.receivers.opsgenie_configs.withDescription

withDescription(description)

"Description of the incident."

fn spec.receivers.opsgenie_configs.withDetails

withDetails(details)

"A set of arbitrary key/value pairs that provide further detail about the incident."

fn spec.receivers.opsgenie_configs.withDetailsMixin

withDetailsMixin(details)

"A set of arbitrary key/value pairs that provide further detail about the incident."

Note: This function appends passed data to existing values

fn spec.receivers.opsgenie_configs.withEntity

withEntity(entity)

"Optional field that can be used to specify which domain alert is related to."

fn spec.receivers.opsgenie_configs.withHttp_config

withHttp_config(http_config)

"HTTP client configuration."

fn spec.receivers.opsgenie_configs.withHttp_configMixin

withHttp_configMixin(http_config)

"HTTP client configuration."

Note: This function appends passed data to existing values

fn spec.receivers.opsgenie_configs.withMessage

withMessage(message)

"Alert text limited to 130 characters."

fn spec.receivers.opsgenie_configs.withNote

withNote(note)

"Additional alert note."

fn spec.receivers.opsgenie_configs.withPriority

withPriority(priority)

"Priority level of alert. Possible values are P1, P2, P3, P4, and P5."

fn spec.receivers.opsgenie_configs.withResponders

withResponders(responders)

"List of responders responsible for notifications."

fn spec.receivers.opsgenie_configs.withRespondersMixin

withRespondersMixin(responders)

"List of responders responsible for notifications."

Note: This function appends passed data to existing values

fn spec.receivers.opsgenie_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.opsgenie_configs.withSource

withSource(source)

"Backlink to the sender of the notification."

fn spec.receivers.opsgenie_configs.withTags

withTags(tags)

"Comma separated list of tags attached to the notifications."

fn spec.receivers.opsgenie_configs.withUpdate_alerts

withUpdate_alerts(update_alerts)

"Whether to update message and description of the alert in OpsGenie if it already exists\nBy default, the alert is never updated in OpsGenie, the new message only appears in activity log."

obj spec.receivers.opsgenie_configs.api_key

"The secret's key that contains the OpsGenie API key.\nIt must be at them same namespace as CRD\nfallback to global setting if empty"

fn spec.receivers.opsgenie_configs.api_key.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.opsgenie_configs.api_key.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.opsgenie_configs.api_key.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.opsgenie_configs.responders

"List of responders responsible for notifications."

fn spec.receivers.opsgenie_configs.responders.withId

withId(id)

"ID of the responder."

fn spec.receivers.opsgenie_configs.responders.withName

withName(name)

"Name of the responder."

fn spec.receivers.opsgenie_configs.responders.withType

withType(type)

"Type of responder."

fn spec.receivers.opsgenie_configs.responders.withUsername

withUsername(username)

"Username of the responder."

obj spec.receivers.pagerduty_configs

"PagerDutyConfigs defines pager duty notification configurations."

fn spec.receivers.pagerduty_configs.withClass

withClass(class)

"The class/type of the event."

fn spec.receivers.pagerduty_configs.withClient

withClient(client)

"Client identification."

fn spec.receivers.pagerduty_configs.withClient_url

withClient_url(client_url)

"Backlink to the sender of notification."

fn spec.receivers.pagerduty_configs.withComponent

withComponent(component)

"The part or component of the affected system that is broken."

fn spec.receivers.pagerduty_configs.withDescription

withDescription(description)

"Description of the incident."

fn spec.receivers.pagerduty_configs.withDetails

withDetails(details)

"Arbitrary key/value pairs that provide further detail about the incident."

fn spec.receivers.pagerduty_configs.withDetailsMixin

withDetailsMixin(details)

"Arbitrary key/value pairs that provide further detail about the incident."

Note: This function appends passed data to existing values

fn spec.receivers.pagerduty_configs.withGroup

withGroup(group)

"A cluster or grouping of sources."

fn spec.receivers.pagerduty_configs.withHttp_config

withHttp_config(http_config)

"HTTP client configuration."

fn spec.receivers.pagerduty_configs.withHttp_configMixin

withHttp_configMixin(http_config)

"HTTP client configuration."

Note: This function appends passed data to existing values

fn spec.receivers.pagerduty_configs.withImages

withImages(images)

"Images to attach to the incident."

fn spec.receivers.pagerduty_configs.withImagesMixin

withImagesMixin(images)

"Images to attach to the incident."

Note: This function appends passed data to existing values

fn spec.receivers.pagerduty_configs.withLinks

withLinks(links)

"Links to attach to the incident."

fn spec.receivers.pagerduty_configs.withLinksMixin

withLinksMixin(links)

"Links to attach to the incident."

Note: This function appends passed data to existing values

fn spec.receivers.pagerduty_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.pagerduty_configs.withSeverity

withSeverity(severity)

"Severity of the incident."

fn spec.receivers.pagerduty_configs.withUrl

withUrl(url)

"The URL to send requests to."

obj spec.receivers.pagerduty_configs.images

"Images to attach to the incident."

fn spec.receivers.pagerduty_configs.images.withAlt

withAlt(alt)

fn spec.receivers.pagerduty_configs.images.withHref

withHref(href)

fn spec.receivers.pagerduty_configs.images.withSource

withSource(source)

obj spec.receivers.pagerduty_configs.links

"Links to attach to the incident."

fn spec.receivers.pagerduty_configs.links.withHref

withHref(href)

fn spec.receivers.pagerduty_configs.links.withText

withText(text)

obj spec.receivers.pagerduty_configs.routing_key

"The secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or serviceKey needs to be defined.\nIt must be at them same namespace as CRD"

fn spec.receivers.pagerduty_configs.routing_key.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.pagerduty_configs.routing_key.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.pagerduty_configs.routing_key.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.pagerduty_configs.service_key

"The secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or routingKey needs to\nbe defined.\nIt must be at them same namespace as CRD"

fn spec.receivers.pagerduty_configs.service_key.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.pagerduty_configs.service_key.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.pagerduty_configs.service_key.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.pushover_configs

"PushoverConfigs defines push over notification configurations."

fn spec.receivers.pushover_configs.withExpire

withExpire(expire)

"How long your notification will continue to be retried for, unless the user\nacknowledges the notification."

fn spec.receivers.pushover_configs.withHtml

withHtml(html)

"Whether notification message is HTML or plain text."

fn spec.receivers.pushover_configs.withHttp_config

withHttp_config(http_config)

"HTTP client configuration."

fn spec.receivers.pushover_configs.withHttp_configMixin

withHttp_configMixin(http_config)

"HTTP client configuration."

Note: This function appends passed data to existing values

fn spec.receivers.pushover_configs.withMessage

withMessage(message)

"Notification message."

fn spec.receivers.pushover_configs.withPriority

withPriority(priority)

"Priority, see https://pushover.net/api#priority"

fn spec.receivers.pushover_configs.withRetry

withRetry(retry)

"How often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds."

fn spec.receivers.pushover_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.pushover_configs.withSound

withSound(sound)

"The name of one of the sounds supported by device clients to override the user's default sound choice"

fn spec.receivers.pushover_configs.withTitle

withTitle(title)

"Notification title."

fn spec.receivers.pushover_configs.withUrl

withUrl(url)

"A supplementary URL shown alongside the message."

fn spec.receivers.pushover_configs.withUrl_title

withUrl_title(url_title)

"A title for supplementary URL, otherwise just the URL is shown"

obj spec.receivers.pushover_configs.token

"The secret's key that contains the registered application’s API token, see https://pushover.net/apps.\nIt must be at them same namespace as CRD"

fn spec.receivers.pushover_configs.token.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.pushover_configs.token.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.pushover_configs.token.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.pushover_configs.user_key

"The secret's key that contains the recipient user’s user key.\nIt must be at them same namespace as CRD"

fn spec.receivers.pushover_configs.user_key.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.pushover_configs.user_key.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.pushover_configs.user_key.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.slack_configs

"SlackConfigs defines slack notification configurations."

fn spec.receivers.slack_configs.withActions

withActions(actions)

"A list of Slack actions that are sent with each notification."

fn spec.receivers.slack_configs.withActionsMixin

withActionsMixin(actions)

"A list of Slack actions that are sent with each notification."

Note: This function appends passed data to existing values

fn spec.receivers.slack_configs.withCallback_id

withCallback_id(callback_id)

fn spec.receivers.slack_configs.withChannel

withChannel(channel)

"The channel or user to send notifications to."

fn spec.receivers.slack_configs.withColor

withColor(color)

fn spec.receivers.slack_configs.withFallback

withFallback(fallback)

fn spec.receivers.slack_configs.withFields

withFields(fields)

"A list of Slack fields that are sent with each notification."

fn spec.receivers.slack_configs.withFieldsMixin

withFieldsMixin(fields)

"A list of Slack fields that are sent with each notification."

Note: This function appends passed data to existing values

fn spec.receivers.slack_configs.withFooter

withFooter(footer)

fn spec.receivers.slack_configs.withHttp_config

withHttp_config(http_config)

"HTTP client configuration."

fn spec.receivers.slack_configs.withHttp_configMixin

withHttp_configMixin(http_config)

"HTTP client configuration."

Note: This function appends passed data to existing values

fn spec.receivers.slack_configs.withIcon_emoji

withIcon_emoji(icon_emoji)

fn spec.receivers.slack_configs.withIcon_url

withIcon_url(icon_url)

fn spec.receivers.slack_configs.withImage_url

withImage_url(image_url)

fn spec.receivers.slack_configs.withLink_names

withLink_names(link_names)

fn spec.receivers.slack_configs.withMrkdwn_in

withMrkdwn_in(mrkdwn_in)

fn spec.receivers.slack_configs.withMrkdwn_inMixin

withMrkdwn_inMixin(mrkdwn_in)

Note: This function appends passed data to existing values

fn spec.receivers.slack_configs.withPretext

withPretext(pretext)

fn spec.receivers.slack_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.slack_configs.withShort_fields

withShort_fields(short_fields)

fn spec.receivers.slack_configs.withText

withText(text)

fn spec.receivers.slack_configs.withThumb_url

withThumb_url(thumb_url)

fn spec.receivers.slack_configs.withTitle

withTitle(title)

fn spec.receivers.slack_configs.withTitle_link

withTitle_link(title_link)

fn spec.receivers.slack_configs.withUsername

withUsername(username)

obj spec.receivers.slack_configs.actions

"A list of Slack actions that are sent with each notification."

fn spec.receivers.slack_configs.actions.withName

withName(name)

fn spec.receivers.slack_configs.actions.withStyle

withStyle(style)

fn spec.receivers.slack_configs.actions.withText

withText(text)

fn spec.receivers.slack_configs.actions.withType

withType(type)

fn spec.receivers.slack_configs.actions.withUrl

withUrl(url)

fn spec.receivers.slack_configs.actions.withValue

withValue(value)

obj spec.receivers.slack_configs.actions.confirm

"SlackConfirmationField protect users from destructive actions or\nparticularly distinguished decisions by asking them to confirm their button\nclick one more time.\nSee https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields\nfor more information."

fn spec.receivers.slack_configs.actions.confirm.withDismiss_text

withDismiss_text(dismiss_text)

fn spec.receivers.slack_configs.actions.confirm.withOk_text

withOk_text(ok_text)

fn spec.receivers.slack_configs.actions.confirm.withText

withText(text)

fn spec.receivers.slack_configs.actions.confirm.withTitle

withTitle(title)

obj spec.receivers.slack_configs.api_url

"The secret's key that contains the Slack webhook URL.\nIt must be at them same namespace as CRD\nfallback to global setting if empty"

fn spec.receivers.slack_configs.api_url.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.slack_configs.api_url.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.slack_configs.api_url.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.slack_configs.fields

"A list of Slack fields that are sent with each notification."

fn spec.receivers.slack_configs.fields.withShort

withShort(short)

fn spec.receivers.slack_configs.fields.withTitle

withTitle(title)

fn spec.receivers.slack_configs.fields.withValue

withValue(value)

obj spec.receivers.sns_configs

fn spec.receivers.sns_configs.withApi_url

withApi_url(api_url)

"The api URL"

fn spec.receivers.sns_configs.withAttributes

withAttributes(attributes)

"SNS message attributes"

fn spec.receivers.sns_configs.withAttributesMixin

withAttributesMixin(attributes)

"SNS message attributes"

Note: This function appends passed data to existing values

fn spec.receivers.sns_configs.withMessage

withMessage(message)

"The message content of the SNS notification."

fn spec.receivers.sns_configs.withPhone_number

withPhone_number(phone_number)

"Phone number if message is delivered via SMS\nSpecify this, topic_arn or target_arn"

fn spec.receivers.sns_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.sns_configs.withSubject

withSubject(subject)

"The subject line if message is delivered to an email endpoint."

fn spec.receivers.sns_configs.withTarget_arn

withTarget_arn(target_arn)

"Mobile platform endpoint ARN if message is delivered via mobile notifications\nSpecify this, topic_arn or phone_number"

fn spec.receivers.sns_configs.withTopic_arn

withTopic_arn(topic_arn)

"SNS topic ARN, either specify this, phone_number or target_arn"

obj spec.receivers.sns_configs.http_config

"HTTP client configuration."

fn spec.receivers.sns_configs.http_config.withBearer_token_file

withBearer_token_file(bearer_token_file)

"BearerTokenFile defines filename for bearer token, it must be mounted to pod."

fn spec.receivers.sns_configs.http_config.withProxyURL

withProxyURL(proxyURL)

"Optional proxy URL."

obj spec.receivers.sns_configs.http_config.authorization

"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."

fn spec.receivers.sns_configs.http_config.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File with value for authorization"

fn spec.receivers.sns_configs.http_config.authorization.withType

withType(type)

"Type of authorization, default to bearer"

obj spec.receivers.sns_configs.http_config.authorization.credentials

"Reference to the secret with value for authorization"

fn spec.receivers.sns_configs.http_config.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.authorization.credentials.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.basic_auth

"BasicAuth for the client."

fn spec.receivers.sns_configs.http_config.basic_auth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.receivers.sns_configs.http_config.basic_auth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.sns_configs.http_config.basic_auth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.basic_auth.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.basic_auth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.basic_auth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.sns_configs.http_config.basic_auth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.basic_auth.username.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.basic_auth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.bearer_token_secret

"The secret's key that contains the bearer token\nIt must be at them same namespace as CRD"

fn spec.receivers.sns_configs.http_config.bearer_token_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.bearer_token_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.bearer_token_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.oauth2

"OAuth2 client credentials used to fetch a token for the targets."

fn spec.receivers.sns_configs.http_config.oauth2.withClient_secret_file

withClient_secret_file(client_secret_file)

"ClientSecretFile defines path for client secret file."

fn spec.receivers.sns_configs.http_config.oauth2.withEndpoint_params

withEndpoint_params(endpoint_params)

"Parameters to append to the token URL"

fn spec.receivers.sns_configs.http_config.oauth2.withEndpoint_paramsMixin

withEndpoint_paramsMixin(endpoint_params)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.receivers.sns_configs.http_config.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.receivers.sns_configs.http_config.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.receivers.sns_configs.http_config.oauth2.withToken_url

withToken_url(token_url)

"The URL to fetch the token from"

obj spec.receivers.sns_configs.http_config.oauth2.client_id

"The secret or configmap containing the OAuth2 client id"

obj spec.receivers.sns_configs.http_config.oauth2.client_id.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.sns_configs.http_config.oauth2.client_id.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.sns_configs.http_config.oauth2.client_id.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.oauth2.client_id.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.sns_configs.http_config.oauth2.client_id.secret

"Secret containing data to use for the targets."

fn spec.receivers.sns_configs.http_config.oauth2.client_id.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.oauth2.client_id.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.oauth2.client_id.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.oauth2.client_secret

"The secret containing the OAuth2 client secret"

fn spec.receivers.sns_configs.http_config.oauth2.client_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.oauth2.client_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.oauth2.client_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.tls_config

"TLS configuration for the client."

fn spec.receivers.sns_configs.http_config.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.sns_configs.http_config.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.sns_configs.http_config.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.sns_configs.http_config.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.sns_configs.http_config.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.sns_configs.http_config.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.sns_configs.http_config.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.sns_configs.http_config.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.sns_configs.http_config.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.http_config.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.sns_configs.http_config.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.http_config.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.http_config.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.sigv4

"Configure the AWS Signature Verification 4 signing process"

fn spec.receivers.sns_configs.sigv4.withAccess_key

withAccess_key(access_key)

"The AWS API keys. Both access_key and secret_key must be supplied or both must be blank.\nIf blank the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used."

fn spec.receivers.sns_configs.sigv4.withProfile

withProfile(profile)

"Named AWS profile used to authenticate"

fn spec.receivers.sns_configs.sigv4.withRegion

withRegion(region)

"AWS region, if blank the region from the default credentials chain is used"

fn spec.receivers.sns_configs.sigv4.withRole_arn

withRole_arn(role_arn)

"AWS Role ARN, an alternative to using AWS API keys"

obj spec.receivers.sns_configs.sigv4.access_key_selector

"secret key selector to get the keys from a Kubernetes Secret"

fn spec.receivers.sns_configs.sigv4.access_key_selector.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.sigv4.access_key_selector.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.sigv4.access_key_selector.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.sns_configs.sigv4.secret_key_selector

"secret key selector to get the keys from a Kubernetes Secret"

fn spec.receivers.sns_configs.sigv4.secret_key_selector.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.sns_configs.sigv4.secret_key_selector.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.sns_configs.sigv4.secret_key_selector.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.telegram_configs

fn spec.receivers.telegram_configs.withApi_url

withApi_url(api_url)

"APIUrl the Telegram API URL i.e. https://api.telegram.org."

fn spec.receivers.telegram_configs.withChat_id

withChat_id(chat_id)

"ChatID is ID of the chat where to send the messages."

fn spec.receivers.telegram_configs.withDisable_notifications

withDisable_notifications(disable_notifications)

"DisableNotifications"

fn spec.receivers.telegram_configs.withHttp_config

withHttp_config(http_config)

"HTTP client configuration."

fn spec.receivers.telegram_configs.withHttp_configMixin

withHttp_configMixin(http_config)

"HTTP client configuration."

Note: This function appends passed data to existing values

fn spec.receivers.telegram_configs.withMessage

withMessage(message)

"Message is templated message"

fn spec.receivers.telegram_configs.withParse_mode

withParse_mode(parse_mode)

"ParseMode for telegram message,\nsupported values are MarkdownV2, Markdown, Markdown and empty string for plain text."

fn spec.receivers.telegram_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

obj spec.receivers.telegram_configs.bot_token

"BotToken token for the bot\nhttps://core.telegram.org/bots/api"

fn spec.receivers.telegram_configs.bot_token.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.telegram_configs.bot_token.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.telegram_configs.bot_token.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs

"VictorOpsConfigs defines victor ops notification configurations."

fn spec.receivers.victorops_configs.withApi_url

withApi_url(api_url)

"The VictorOps API URL."

fn spec.receivers.victorops_configs.withCustom_fields

withCustom_fields(custom_fields)

"Adds optional custom fields\nhttps://github.com/prometheus/alertmanager/blob/v0.24.0/config/notifiers.go#L537"

fn spec.receivers.victorops_configs.withCustom_fieldsMixin

withCustom_fieldsMixin(custom_fields)

"Adds optional custom fields\nhttps://github.com/prometheus/alertmanager/blob/v0.24.0/config/notifiers.go#L537"

Note: This function appends passed data to existing values

fn spec.receivers.victorops_configs.withEntity_display_name

withEntity_display_name(entity_display_name)

"Contains summary of the alerted problem."

fn spec.receivers.victorops_configs.withMessage_type

withMessage_type(message_type)

"Describes the behavior of the alert (CRITICAL, WARNING, INFO)."

fn spec.receivers.victorops_configs.withMonitoring_tool

withMonitoring_tool(monitoring_tool)

"The monitoring tool the state message is from."

fn spec.receivers.victorops_configs.withRouting_key

withRouting_key(routing_key)

"A key used to map the alert to a team."

fn spec.receivers.victorops_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.victorops_configs.withState_message

withState_message(state_message)

"Contains long explanation of the alerted problem."

obj spec.receivers.victorops_configs.api_key

"The secret's key that contains the API key to use when talking to the VictorOps API.\nIt must be at them same namespace as CRD\nfallback to global setting if empty"

fn spec.receivers.victorops_configs.api_key.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.api_key.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.api_key.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config

"The HTTP client's configuration."

fn spec.receivers.victorops_configs.http_config.withBearer_token_file

withBearer_token_file(bearer_token_file)

"BearerTokenFile defines filename for bearer token, it must be mounted to pod."

fn spec.receivers.victorops_configs.http_config.withProxyURL

withProxyURL(proxyURL)

"Optional proxy URL."

obj spec.receivers.victorops_configs.http_config.authorization

"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."

fn spec.receivers.victorops_configs.http_config.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File with value for authorization"

fn spec.receivers.victorops_configs.http_config.authorization.withType

withType(type)

"Type of authorization, default to bearer"

obj spec.receivers.victorops_configs.http_config.authorization.credentials

"Reference to the secret with value for authorization"

fn spec.receivers.victorops_configs.http_config.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.authorization.credentials.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.basic_auth

"BasicAuth for the client."

fn spec.receivers.victorops_configs.http_config.basic_auth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.receivers.victorops_configs.http_config.basic_auth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.victorops_configs.http_config.basic_auth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.basic_auth.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.basic_auth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.basic_auth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.victorops_configs.http_config.basic_auth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.basic_auth.username.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.basic_auth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.bearer_token_secret

"The secret's key that contains the bearer token\nIt must be at them same namespace as CRD"

fn spec.receivers.victorops_configs.http_config.bearer_token_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.bearer_token_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.bearer_token_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.oauth2

"OAuth2 client credentials used to fetch a token for the targets."

fn spec.receivers.victorops_configs.http_config.oauth2.withClient_secret_file

withClient_secret_file(client_secret_file)

"ClientSecretFile defines path for client secret file."

fn spec.receivers.victorops_configs.http_config.oauth2.withEndpoint_params

withEndpoint_params(endpoint_params)

"Parameters to append to the token URL"

fn spec.receivers.victorops_configs.http_config.oauth2.withEndpoint_paramsMixin

withEndpoint_paramsMixin(endpoint_params)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.receivers.victorops_configs.http_config.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.receivers.victorops_configs.http_config.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.receivers.victorops_configs.http_config.oauth2.withToken_url

withToken_url(token_url)

"The URL to fetch the token from"

obj spec.receivers.victorops_configs.http_config.oauth2.client_id

"The secret or configmap containing the OAuth2 client id"

obj spec.receivers.victorops_configs.http_config.oauth2.client_id.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.victorops_configs.http_config.oauth2.client_id.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.victorops_configs.http_config.oauth2.client_id.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.oauth2.client_id.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.victorops_configs.http_config.oauth2.client_id.secret

"Secret containing data to use for the targets."

fn spec.receivers.victorops_configs.http_config.oauth2.client_id.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.oauth2.client_id.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.oauth2.client_id.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.oauth2.client_secret

"The secret containing the OAuth2 client secret"

fn spec.receivers.victorops_configs.http_config.oauth2.client_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.oauth2.client_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.oauth2.client_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.tls_config

"TLS configuration for the client."

fn spec.receivers.victorops_configs.http_config.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.victorops_configs.http_config.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.victorops_configs.http_config.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.victorops_configs.http_config.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.victorops_configs.http_config.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.victorops_configs.http_config.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.victorops_configs.http_config.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.victorops_configs.http_config.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.victorops_configs.http_config.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.victorops_configs.http_config.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.victorops_configs.http_config.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.victorops_configs.http_config.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.victorops_configs.http_config.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs

fn spec.receivers.webex_configs.withApi_url

withApi_url(api_url)

"The Webex Teams API URL, i.e. https://webexapis.com/v1/messages"

fn spec.receivers.webex_configs.withMessage

withMessage(message)

"The message body template"

fn spec.receivers.webex_configs.withRoom_id

withRoom_id(room_id)

"The ID of the Webex Teams room where to send the messages"

fn spec.receivers.webex_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

obj spec.receivers.webex_configs.http_config

"HTTP client configuration. You must use this configuration to supply the bot token as part of the HTTP Authorization header."

fn spec.receivers.webex_configs.http_config.withBearer_token_file

withBearer_token_file(bearer_token_file)

"BearerTokenFile defines filename for bearer token, it must be mounted to pod."

fn spec.receivers.webex_configs.http_config.withProxyURL

withProxyURL(proxyURL)

"Optional proxy URL."

obj spec.receivers.webex_configs.http_config.authorization

"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."

fn spec.receivers.webex_configs.http_config.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File with value for authorization"

fn spec.receivers.webex_configs.http_config.authorization.withType

withType(type)

"Type of authorization, default to bearer"

obj spec.receivers.webex_configs.http_config.authorization.credentials

"Reference to the secret with value for authorization"

fn spec.receivers.webex_configs.http_config.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.authorization.credentials.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.basic_auth

"BasicAuth for the client."

fn spec.receivers.webex_configs.http_config.basic_auth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.receivers.webex_configs.http_config.basic_auth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.webex_configs.http_config.basic_auth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.basic_auth.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.basic_auth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.basic_auth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.webex_configs.http_config.basic_auth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.basic_auth.username.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.basic_auth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.bearer_token_secret

"The secret's key that contains the bearer token\nIt must be at them same namespace as CRD"

fn spec.receivers.webex_configs.http_config.bearer_token_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.bearer_token_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.bearer_token_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.oauth2

"OAuth2 client credentials used to fetch a token for the targets."

fn spec.receivers.webex_configs.http_config.oauth2.withClient_secret_file

withClient_secret_file(client_secret_file)

"ClientSecretFile defines path for client secret file."

fn spec.receivers.webex_configs.http_config.oauth2.withEndpoint_params

withEndpoint_params(endpoint_params)

"Parameters to append to the token URL"

fn spec.receivers.webex_configs.http_config.oauth2.withEndpoint_paramsMixin

withEndpoint_paramsMixin(endpoint_params)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.receivers.webex_configs.http_config.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.receivers.webex_configs.http_config.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.receivers.webex_configs.http_config.oauth2.withToken_url

withToken_url(token_url)

"The URL to fetch the token from"

obj spec.receivers.webex_configs.http_config.oauth2.client_id

"The secret or configmap containing the OAuth2 client id"

obj spec.receivers.webex_configs.http_config.oauth2.client_id.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.webex_configs.http_config.oauth2.client_id.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.webex_configs.http_config.oauth2.client_id.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.oauth2.client_id.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.webex_configs.http_config.oauth2.client_id.secret

"Secret containing data to use for the targets."

fn spec.receivers.webex_configs.http_config.oauth2.client_id.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.oauth2.client_id.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.oauth2.client_id.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.oauth2.client_secret

"The secret containing the OAuth2 client secret"

fn spec.receivers.webex_configs.http_config.oauth2.client_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.oauth2.client_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.oauth2.client_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.tls_config

"TLS configuration for the client."

fn spec.receivers.webex_configs.http_config.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.webex_configs.http_config.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.webex_configs.http_config.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.webex_configs.http_config.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.webex_configs.http_config.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.webex_configs.http_config.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.webex_configs.http_config.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.webex_configs.http_config.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.webex_configs.http_config.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webex_configs.http_config.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.webex_configs.http_config.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webex_configs.http_config.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webex_configs.http_config.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.webhook_configs

"WebhookConfigs defines webhook notification configurations."

fn spec.receivers.webhook_configs.withHttp_config

withHttp_config(http_config)

"HTTP client configuration."

fn spec.receivers.webhook_configs.withHttp_configMixin

withHttp_configMixin(http_config)

"HTTP client configuration."

Note: This function appends passed data to existing values

fn spec.receivers.webhook_configs.withMax_alerts

withMax_alerts(max_alerts)

"Maximum number of alerts to be sent per webhook message. When 0, all alerts are included."

fn spec.receivers.webhook_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.webhook_configs.withUrl

withUrl(url)

"URL to send requests to,\none of urlSecret and url must be defined."

obj spec.receivers.webhook_configs.url_secret

"URLSecret defines secret name and key at the CRD namespace.\nIt must contain the webhook URL.\none of urlSecret and url must be defined."

fn spec.receivers.webhook_configs.url_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.webhook_configs.url_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.webhook_configs.url_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs

"WeChatConfigs defines wechat notification configurations."

fn spec.receivers.wechat_configs.withAgent_id

withAgent_id(agent_id)

fn spec.receivers.wechat_configs.withApi_url

withApi_url(api_url)

"The WeChat API URL.\nfallback to global alertmanager setting if empty"

fn spec.receivers.wechat_configs.withCorp_id

withCorp_id(corp_id)

"The corp id for authentication.\nfallback to global alertmanager setting if empty"

fn spec.receivers.wechat_configs.withMessage

withMessage(message)

"API request data as defined by the WeChat API."

fn spec.receivers.wechat_configs.withMessage_type

withMessage_type(message_type)

fn spec.receivers.wechat_configs.withSend_resolved

withSend_resolved(send_resolved)

"SendResolved controls notify about resolved alerts."

fn spec.receivers.wechat_configs.withTo_party

withTo_party(to_party)

fn spec.receivers.wechat_configs.withTo_tag

withTo_tag(to_tag)

fn spec.receivers.wechat_configs.withTo_user

withTo_user(to_user)

obj spec.receivers.wechat_configs.api_secret

"The secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nfallback to global alertmanager setting if empty"

fn spec.receivers.wechat_configs.api_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.api_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.api_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config

"HTTP client configuration."

fn spec.receivers.wechat_configs.http_config.withBearer_token_file

withBearer_token_file(bearer_token_file)

"BearerTokenFile defines filename for bearer token, it must be mounted to pod."

fn spec.receivers.wechat_configs.http_config.withProxyURL

withProxyURL(proxyURL)

"Optional proxy URL."

obj spec.receivers.wechat_configs.http_config.authorization

"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."

fn spec.receivers.wechat_configs.http_config.authorization.withCredentialsFile

withCredentialsFile(credentialsFile)

"File with value for authorization"

fn spec.receivers.wechat_configs.http_config.authorization.withType

withType(type)

"Type of authorization, default to bearer"

obj spec.receivers.wechat_configs.http_config.authorization.credentials

"Reference to the secret with value for authorization"

fn spec.receivers.wechat_configs.http_config.authorization.credentials.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.authorization.credentials.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.authorization.credentials.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.basic_auth

"BasicAuth for the client."

fn spec.receivers.wechat_configs.http_config.basic_auth.withPassword_file

withPassword_file(password_file)

"PasswordFile defines path to password file at disk\nmust be pre-mounted"

obj spec.receivers.wechat_configs.http_config.basic_auth.password

"Password defines reference for secret with password value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.wechat_configs.http_config.basic_auth.password.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.basic_auth.password.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.basic_auth.password.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.basic_auth.username

"Username defines reference for secret with username value\nThe secret needs to be in the same namespace as scrape object"

fn spec.receivers.wechat_configs.http_config.basic_auth.username.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.basic_auth.username.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.basic_auth.username.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.bearer_token_secret

"The secret's key that contains the bearer token\nIt must be at them same namespace as CRD"

fn spec.receivers.wechat_configs.http_config.bearer_token_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.bearer_token_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.bearer_token_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.oauth2

"OAuth2 client credentials used to fetch a token for the targets."

fn spec.receivers.wechat_configs.http_config.oauth2.withClient_secret_file

withClient_secret_file(client_secret_file)

"ClientSecretFile defines path for client secret file."

fn spec.receivers.wechat_configs.http_config.oauth2.withEndpoint_params

withEndpoint_params(endpoint_params)

"Parameters to append to the token URL"

fn spec.receivers.wechat_configs.http_config.oauth2.withEndpoint_paramsMixin

withEndpoint_paramsMixin(endpoint_params)

"Parameters to append to the token URL"

Note: This function appends passed data to existing values

fn spec.receivers.wechat_configs.http_config.oauth2.withScopes

withScopes(scopes)

"OAuth2 scopes used for the token request"

fn spec.receivers.wechat_configs.http_config.oauth2.withScopesMixin

withScopesMixin(scopes)

"OAuth2 scopes used for the token request"

Note: This function appends passed data to existing values

fn spec.receivers.wechat_configs.http_config.oauth2.withToken_url

withToken_url(token_url)

"The URL to fetch the token from"

obj spec.receivers.wechat_configs.http_config.oauth2.client_id

"The secret or configmap containing the OAuth2 client id"

obj spec.receivers.wechat_configs.http_config.oauth2.client_id.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.wechat_configs.http_config.oauth2.client_id.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.wechat_configs.http_config.oauth2.client_id.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.oauth2.client_id.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.wechat_configs.http_config.oauth2.client_id.secret

"Secret containing data to use for the targets."

fn spec.receivers.wechat_configs.http_config.oauth2.client_id.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.oauth2.client_id.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.oauth2.client_id.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.oauth2.client_secret

"The secret containing the OAuth2 client secret"

fn spec.receivers.wechat_configs.http_config.oauth2.client_secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.oauth2.client_secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.oauth2.client_secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.tls_config

"TLS configuration for the client."

fn spec.receivers.wechat_configs.http_config.tls_config.withCaFile

withCaFile(caFile)

"Path to the CA cert in the container to use for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.withCertFile

withCertFile(certFile)

"Path to the client cert file in the container for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.withInsecureSkipVerify

withInsecureSkipVerify(insecureSkipVerify)

"Disable target certificate validation."

fn spec.receivers.wechat_configs.http_config.tls_config.withKeyFile

withKeyFile(keyFile)

"Path to the client key file in the container for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.withServerName

withServerName(serverName)

"Used to verify the hostname for the targets."

obj spec.receivers.wechat_configs.http_config.tls_config.ca

"Stuct containing the CA cert to use for the targets."

obj spec.receivers.wechat_configs.http_config.tls_config.ca.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.ca.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.wechat_configs.http_config.tls_config.ca.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.tls_config.ca.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.wechat_configs.http_config.tls_config.ca.secret

"Secret containing data to use for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.ca.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.tls_config.ca.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.tls_config.ca.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.tls_config.cert

"Struct containing the client cert file for the targets."

obj spec.receivers.wechat_configs.http_config.tls_config.cert.configMap

"ConfigMap containing data to use for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.cert.configMap.withKey

withKey(key)

"The key to select."

fn spec.receivers.wechat_configs.http_config.tls_config.cert.configMap.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.tls_config.cert.configMap.withOptional

withOptional(optional)

"Specify whether the ConfigMap or its key must be defined"

obj spec.receivers.wechat_configs.http_config.tls_config.cert.secret

"Secret containing data to use for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.cert.secret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.tls_config.cert.secret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.tls_config.cert.secret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.receivers.wechat_configs.http_config.tls_config.keySecret

"Secret containing the client key file for the targets."

fn spec.receivers.wechat_configs.http_config.tls_config.keySecret.withKey

withKey(key)

"The key of the secret to select from. Must be a valid secret key."

fn spec.receivers.wechat_configs.http_config.tls_config.keySecret.withName

withName(name)

"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.receivers.wechat_configs.http_config.tls_config.keySecret.withOptional

withOptional(optional)

"Specify whether the Secret or its key must be defined"

obj spec.route

"Route definition for alertmanager, may include nested routes."

fn spec.route.withActive_time_intervals

withActive_time_intervals(active_time_intervals)

"ActiveTimeIntervals Times when the route should be active\nThese must match the name at time_intervals"

fn spec.route.withActive_time_intervalsMixin

withActive_time_intervalsMixin(active_time_intervals)

"ActiveTimeIntervals Times when the route should be active\nThese must match the name at time_intervals"

Note: This function appends passed data to existing values

fn spec.route.withContinue

withContinue(continue)

"Continue indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be true for the first-level route if disableRouteContinueEnforce for vmalertmanager not set."

fn spec.route.withGroup_by

withGroup_by(group_by)

"List of labels to group by."

fn spec.route.withGroup_byMixin

withGroup_byMixin(group_by)

"List of labels to group by."

Note: This function appends passed data to existing values

fn spec.route.withGroup_interval

withGroup_interval(group_interval)

"How long to wait before sending an updated notification."

fn spec.route.withGroup_wait

withGroup_wait(group_wait)

"How long to wait before sending the initial notification."

fn spec.route.withMatchers

withMatchers(matchers)

"List of matchers that the alert’s labels should match. For the first\nlevel route, the operator adds a namespace: \"CRD_NS\" matcher.\nhttps://prometheus.io/docs/alerting/latest/configuration/#matcher"

fn spec.route.withMatchersMixin

withMatchersMixin(matchers)

"List of matchers that the alert’s labels should match. For the first\nlevel route, the operator adds a namespace: \"CRD_NS\" matcher.\nhttps://prometheus.io/docs/alerting/latest/configuration/#matcher"

Note: This function appends passed data to existing values

fn spec.route.withMute_time_intervals

withMute_time_intervals(mute_time_intervals)

"MuteTimeIntervals is a list of interval names that will mute matched alert"

fn spec.route.withMute_time_intervalsMixin

withMute_time_intervalsMixin(mute_time_intervals)

"MuteTimeIntervals is a list of interval names that will mute matched alert"

Note: This function appends passed data to existing values

fn spec.route.withReceiver

withReceiver(receiver)

"Name of the receiver for this route."

fn spec.route.withRepeat_interval

withRepeat_interval(repeat_interval)

"How long to wait before repeating the last notification."

fn spec.route.withRoutes

withRoutes(routes)

"Child routes.\nhttps://prometheus.io/docs/alerting/latest/configuration/#route"

fn spec.route.withRoutesMixin

withRoutesMixin(routes)

"Child routes.\nhttps://prometheus.io/docs/alerting/latest/configuration/#route"

Note: This function appends passed data to existing values

obj spec.time_intervals

"TimeIntervals defines named interval for active/mute notifications interval\nSee https://prometheus.io/docs/alerting/latest/configuration/#time_interval"

fn spec.time_intervals.withName

withName(name)

"Name of interval"

fn spec.time_intervals.withTime_intervals

withTime_intervals(time_intervals)

"TimeIntervals interval configuration"

fn spec.time_intervals.withTime_intervalsMixin

withTime_intervalsMixin(time_intervals)

"TimeIntervals interval configuration"

Note: This function appends passed data to existing values

obj spec.time_intervals.time_intervals

"TimeIntervals interval configuration"

fn spec.time_intervals.time_intervals.withDays_of_month

withDays_of_month(days_of_month)

"DayOfMonth defines list of numerical days in the month. Days begin at 1. Negative values are also accepted.\nfor example, ['1:5', '-3:-1']"

fn spec.time_intervals.time_intervals.withDays_of_monthMixin

withDays_of_monthMixin(days_of_month)

"DayOfMonth defines list of numerical days in the month. Days begin at 1. Negative values are also accepted.\nfor example, ['1:5', '-3:-1']"

Note: This function appends passed data to existing values

fn spec.time_intervals.time_intervals.withLocation

withLocation(location)

"Location in golang time location form, e.g. UTC"

fn spec.time_intervals.time_intervals.withMonths

withMonths(months)

"Months defines list of calendar months identified by a case-insensitive name (e.g. ‘January’) or numeric 1.\nFor example, ['1:3', 'may:august', 'december']"

fn spec.time_intervals.time_intervals.withMonthsMixin

withMonthsMixin(months)

"Months defines list of calendar months identified by a case-insensitive name (e.g. ‘January’) or numeric 1.\nFor example, ['1:3', 'may:august', 'december']"

Note: This function appends passed data to existing values

fn spec.time_intervals.time_intervals.withTimes

withTimes(times)

"Times defines time range for mute"

fn spec.time_intervals.time_intervals.withTimesMixin

withTimesMixin(times)

"Times defines time range for mute"

Note: This function appends passed data to existing values

fn spec.time_intervals.time_intervals.withWeekdays

withWeekdays(weekdays)

"Weekdays defines list of days of the week, where the week begins on Sunday and ends on Saturday."

fn spec.time_intervals.time_intervals.withWeekdaysMixin

withWeekdaysMixin(weekdays)

"Weekdays defines list of days of the week, where the week begins on Sunday and ends on Saturday."

Note: This function appends passed data to existing values

fn spec.time_intervals.time_intervals.withYears

withYears(years)

"Years defines numerical list of years, ranges are accepted.\nFor example, ['2020:2022', '2030']"

fn spec.time_intervals.time_intervals.withYearsMixin

withYearsMixin(years)

"Years defines numerical list of years, ranges are accepted.\nFor example, ['2020:2022', '2030']"

Note: This function appends passed data to existing values

obj spec.time_intervals.time_intervals.times

"Times defines time range for mute"

fn spec.time_intervals.time_intervals.times.withEnd_time

withEnd_time(end_time)

"EndTime for example HH:MM"

fn spec.time_intervals.time_intervals.times.withStart_time

withStart_time(start_time)

"StartTime for example HH:MM"