public final class WebNotificationHook extends NotificationHook
Constructor and Description |
---|
WebNotificationHook(String name,
String endpoint)
Create a new instance of WebNotificationHook.
|
Modifier and Type | Method and Description |
---|---|
String |
getClientCertificate()
The HTTPS client certificate to access the endpoint.
|
String |
getClientCertificatePassword()
The password of the HTTPS client certificate to access the endpoint.
|
String |
getDescription()
Gets the description for the Notification hook.
|
String |
getEndpoint()
Gets the web endpoint that receives incident alerts.
|
String |
getExternalLink()
Gets the external link url, this will be included in the notification sent to the users,
this is usually a reference to any troubleshooting guide.
|
com.azure.core.http.HttpHeaders |
getHttpHeaders()
Gets the HTTP headers to send while sending alert to the endpoint.
|
String |
getName()
Gets the name for the Notification hook.
|
String |
getPassword()
Gets the password to authenticate the endpoint.
|
String |
getUsername()
Gets the user name to authenticate the endpoint.
|
WebNotificationHook |
setAdmins(List<String> admins)
Sets the user e-mails and clientIds with administrative rights to manage the hook.
|
WebNotificationHook |
setClientCertificate(String certificate,
String password)
Sets the HTTPS certificate to use to access the endpoint.
|
WebNotificationHook |
setDescription(String description)
Sets web hook description.
|
WebNotificationHook |
setEndPoint(String endpoint)
The web endpoint to notify incident alerts.
|
WebNotificationHook |
setExternalLink(String externalLink)
Sets the customized external link, it will be included in the notification sent to the users,
this is usually a reference to any troubleshooting guide.
|
WebNotificationHook |
setHttpHeaders(com.azure.core.http.HttpHeaders httpHeaders)
Sets the HTTP headers to send while sending alert to the endpoint.
|
WebNotificationHook |
setName(String name)
Sets web hook name.
|
WebNotificationHook |
setUserCredentials(String username,
String password)
Sets the credential to access the endpoint.
|
getAdmins, getId
public String getName()
NotificationHook
getName
in class NotificationHook
public String getDescription()
NotificationHook
getDescription
in class NotificationHook
public String getEndpoint()
public String getExternalLink()
public String getUsername()
public String getPassword()
public String getClientCertificate()
public String getClientCertificatePassword()
public com.azure.core.http.HttpHeaders getHttpHeaders()
public WebNotificationHook setEndPoint(String endpoint)
endpoint
- The endpointpublic WebNotificationHook setName(String name)
name
- The web hook name.public WebNotificationHook setDescription(String description)
description
- The web hook description.public WebNotificationHook setExternalLink(String externalLink)
externalLink
- The customized link.public WebNotificationHook setUserCredentials(String username, String password)
username
- The user name.password
- The password.public WebNotificationHook setClientCertificate(String certificate, String password)
certificate
- The certificate.password
- The certificate password.public WebNotificationHook setHttpHeaders(com.azure.core.http.HttpHeaders httpHeaders)
httpHeaders
- The HTTP headers.public WebNotificationHook setAdmins(List<String> admins)
The administrators have total control over the hook, being allowed to update or delete the hook. Each element in this list represents a user with administrator access, but the value of each string element as either user email address or clientId uniquely identifying the user service principal.
admins
- A list containing email or clientId of adminsCopyright © 2021 Microsoft Corporation. All rights reserved.