Class EmailConfig
- java.lang.Object
-
- io.fabric8.openshift.api.model.monitoring.v1alpha1.EmailConfig
-
- All Implemented Interfaces:
Editable<EmailConfigBuilder>,KubernetesResource,Serializable
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator") public class EmailConfig extends Object implements Editable<EmailConfigBuilder>, KubernetesResource
EmailConfig configures notifications via Email.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EmailConfig()No args constructor for use in serializationEmailConfig(String authIdentity, SecretKeySelector authPassword, SecretKeySelector authSecret, String authUsername, Boolean forceImplicitTLS, String from, List<KeyValue> headers, String hello, String html, Boolean requireTLS, Boolean sendResolved, String smarthost, String text, EmailThreadingConfig threading, SafeTLSConfig tlsConfig, String to)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EmailConfigBuilderedit()Map<String,Object>getAdditionalProperties()StringgetAuthIdentity()authIdentity defines the identity to use for SMTP authentication.SecretKeySelectorgetAuthPassword()EmailConfig configures notifications via Email.SecretKeySelectorgetAuthSecret()EmailConfig configures notifications via Email.StringgetAuthUsername()authUsername defines the username to use for SMTP authentication.BooleangetForceImplicitTLS()forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.StringgetFrom()from defines the sender address for email notifications.List<KeyValue>getHeaders()headers defines additional email header key/value pairs.StringgetHello()hello defines the hostname to identify to the SMTP server.StringgetHtml()html defines the HTML body of the email notification.BooleangetRequireTLS()requireTLS defines the SMTP TLS requirement.BooleangetSendResolved()sendResolved defines whether or not to notify about resolved alerts.StringgetSmarthost()smarthost defines the SMTP host and port through which emails are sent.StringgetText()text defines the plain text body of the email notification.EmailThreadingConfiggetThreading()EmailConfig configures notifications via Email.SafeTLSConfiggetTlsConfig()EmailConfig configures notifications via Email.StringgetTo()to defines the email address to send notifications to.voidsetAdditionalProperties(Map<String,Object> additionalProperties)voidsetAdditionalProperty(String name, Object value)voidsetAuthIdentity(String authIdentity)authIdentity defines the identity to use for SMTP authentication.voidsetAuthPassword(SecretKeySelector authPassword)EmailConfig configures notifications via Email.voidsetAuthSecret(SecretKeySelector authSecret)EmailConfig configures notifications via Email.voidsetAuthUsername(String authUsername)authUsername defines the username to use for SMTP authentication.voidsetForceImplicitTLS(Boolean forceImplicitTLS)forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.voidsetFrom(String from)from defines the sender address for email notifications.voidsetHeaders(List<KeyValue> headers)headers defines additional email header key/value pairs.voidsetHello(String hello)hello defines the hostname to identify to the SMTP server.voidsetHtml(String html)html defines the HTML body of the email notification.voidsetRequireTLS(Boolean requireTLS)requireTLS defines the SMTP TLS requirement.voidsetSendResolved(Boolean sendResolved)sendResolved defines whether or not to notify about resolved alerts.voidsetSmarthost(String smarthost)smarthost defines the SMTP host and port through which emails are sent.voidsetText(String text)text defines the plain text body of the email notification.voidsetThreading(EmailThreadingConfig threading)EmailConfig configures notifications via Email.voidsetTlsConfig(SafeTLSConfig tlsConfig)EmailConfig configures notifications via Email.voidsetTo(String to)to defines the email address to send notifications to.EmailConfigBuildertoBuilder()
-
-
-
Constructor Detail
-
EmailConfig
public EmailConfig()
No args constructor for use in serialization
-
EmailConfig
public EmailConfig(String authIdentity, SecretKeySelector authPassword, SecretKeySelector authSecret, String authUsername, Boolean forceImplicitTLS, String from, List<KeyValue> headers, String hello, String html, Boolean requireTLS, Boolean sendResolved, String smarthost, String text, EmailThreadingConfig threading, SafeTLSConfig tlsConfig, String to)
-
-
Method Detail
-
getAuthIdentity
public String getAuthIdentity()
authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.
-
setAuthIdentity
public void setAuthIdentity(String authIdentity)
authIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.
-
getAuthPassword
public SecretKeySelector getAuthPassword()
EmailConfig configures notifications via Email.
-
setAuthPassword
public void setAuthPassword(SecretKeySelector authPassword)
EmailConfig configures notifications via Email.
-
getAuthSecret
public SecretKeySelector getAuthSecret()
EmailConfig configures notifications via Email.
-
setAuthSecret
public void setAuthSecret(SecretKeySelector authSecret)
EmailConfig configures notifications via Email.
-
getAuthUsername
public String getAuthUsername()
authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.
-
setAuthUsername
public void setAuthUsername(String authUsername)
authUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.
-
getForceImplicitTLS
public Boolean getForceImplicitTLS()
forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.
-
setForceImplicitTLS
public void setForceImplicitTLS(Boolean forceImplicitTLS)
forceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.
-
getFrom
public String getFrom()
from defines the sender address for email notifications. This appears as the "From" field in the email header.
-
setFrom
public void setFrom(String from)
from defines the sender address for email notifications. This appears as the "From" field in the email header.
-
getHeaders
public List<KeyValue> getHeaders()
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
-
setHeaders
public void setHeaders(List<KeyValue> headers)
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
-
getHello
public String getHello()
hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.
-
setHello
public void setHello(String hello)
hello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.
-
getHtml
public String getHtml()
html defines the HTML body of the email notification. This allows for rich formatting in the email content.
-
setHtml
public void setHtml(String html)
html defines the HTML body of the email notification. This allows for rich formatting in the email content.
-
getRequireTLS
public Boolean getRequireTLS()
requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
-
setRequireTLS
public void setRequireTLS(Boolean requireTLS)
requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
-
getSendResolved
public Boolean getSendResolved()
sendResolved defines whether or not to notify about resolved alerts.
-
setSendResolved
public void setSendResolved(Boolean sendResolved)
sendResolved defines whether or not to notify about resolved alerts.
-
getSmarthost
public String getSmarthost()
smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".
-
setSmarthost
public void setSmarthost(String smarthost)
smarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".
-
getText
public String getText()
text defines the plain text body of the email notification. This provides a fallback for email clients that don't support HTML.
-
setText
public void setText(String text)
text defines the plain text body of the email notification. This provides a fallback for email clients that don't support HTML.
-
getThreading
public EmailThreadingConfig getThreading()
EmailConfig configures notifications via Email.
-
setThreading
public void setThreading(EmailThreadingConfig threading)
EmailConfig configures notifications via Email.
-
getTlsConfig
public SafeTLSConfig getTlsConfig()
EmailConfig configures notifications via Email.
-
setTlsConfig
public void setTlsConfig(SafeTLSConfig tlsConfig)
EmailConfig configures notifications via Email.
-
getTo
public String getTo()
to defines the email address to send notifications to. This is the recipient address for alert notifications.
-
setTo
public void setTo(String to)
to defines the email address to send notifications to. This is the recipient address for alert notifications.
-
edit
public EmailConfigBuilder edit()
- Specified by:
editin interfaceEditable<EmailConfigBuilder>
-
toBuilder
public EmailConfigBuilder toBuilder()
-
-