Notification Class

Package:

com.azure.resourcemanager.consumption.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-consumption:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.consumption.models.Notification

Implements

JsonSerializable<Notification>

public final class Notification
implements JsonSerializable<Notification>

The notification associated with a budget.

Constructor Summary

Constructor	Description
Notification()	Creates an instance of Notification class.

Method Summary

Modifier and Type	Method and Description
List<String>	contactEmails() Get the contactEmails property: Email addresses to send the budget notification to when the threshold is exceeded.
List<String>	contactGroups() Get the contactGroups property: Action groups to send the budget notification to when the threshold is exceeded.
List<String>	contactRoles() Get the contactRoles property: Contact roles to send the budget notification to when the threshold is exceeded.
boolean	enabled() Get the enabled property: The notification is enabled or not.
static Notification	fromJson(JsonReader jsonReader) Reads an instance of Notification from the JsonReader.
CultureCode	locale() Get the locale property: Language in which the recipient will receive the notification.
OperatorType	operator() Get the operator property: The comparison operator.
BigDecimal	threshold() Get the threshold property: Threshold value associated with a notification.
ThresholdType	thresholdType() Get the thresholdType property: The type of threshold.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
Notification	withContactEmails(List<String> contactEmails) Set the contactEmails property: Email addresses to send the budget notification to when the threshold is exceeded.
Notification	withContactGroups(List<String> contactGroups) Set the contactGroups property: Action groups to send the budget notification to when the threshold is exceeded.
Notification	withContactRoles(List<String> contactRoles) Set the contactRoles property: Contact roles to send the budget notification to when the threshold is exceeded.
Notification	withEnabled(boolean enabled) Set the enabled property: The notification is enabled or not.
Notification	withLocale(CultureCode locale) Set the locale property: Language in which the recipient will receive the notification.
Notification	withOperator(OperatorType operator) Set the operator property: The comparison operator.
Notification	withThreshold(BigDecimal threshold) Set the threshold property: Threshold value associated with a notification.
Notification	withThresholdType(ThresholdType thresholdType) Set the thresholdType property: The type of threshold.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Notification

public Notification()

Creates an instance of Notification class.

Method Details

contactEmails

public List<String> contactEmails()

Get the contactEmails property: Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.

Returns:

the contactEmails value.

contactGroups

public List<String> contactGroups()

Get the contactGroups property: Action groups to send the budget notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id. Only supported at Subscription or Resource Group scopes.

Returns:

the contactGroups value.

contactRoles

public List<String> contactRoles()

Get the contactRoles property: Contact roles to send the budget notification to when the threshold is exceeded.

Returns:

the contactRoles value.

enabled

public boolean enabled()

Get the enabled property: The notification is enabled or not.

Returns:

the enabled value.

fromJson

public static Notification fromJson(JsonReader jsonReader)

Reads an instance of Notification from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Notification if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

locale

public CultureCode locale()

Get the locale property: Language in which the recipient will receive the notification.

Returns:

the locale value.

operator

public OperatorType operator()

Get the operator property: The comparison operator.

Returns:

the operator value.

threshold

public BigDecimal threshold()

Get the threshold property: Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

Returns:

the threshold value.

thresholdType

public ThresholdType thresholdType()

Get the thresholdType property: The type of threshold.

Returns:

the thresholdType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withContactEmails

public Notification withContactEmails(List<String> contactEmails)

Set the contactEmails property: Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.

Parameters:

contactEmails - the contactEmails value to set.

Returns:

the Notification object itself.

withContactGroups

public Notification withContactGroups(List<String> contactGroups)

Set the contactGroups property: Action groups to send the budget notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id. Only supported at Subscription or Resource Group scopes.

Parameters:

contactGroups - the contactGroups value to set.

Returns:

the Notification object itself.

withContactRoles

public Notification withContactRoles(List<String> contactRoles)

Set the contactRoles property: Contact roles to send the budget notification to when the threshold is exceeded.

Parameters:

contactRoles - the contactRoles value to set.

Returns:

the Notification object itself.

withEnabled

public Notification withEnabled(boolean enabled)

Set the enabled property: The notification is enabled or not.

Parameters:

enabled - the enabled value to set.

Returns:

the Notification object itself.

withLocale

public Notification withLocale(CultureCode locale)

Set the locale property: Language in which the recipient will receive the notification.

Parameters:

locale - the locale value to set.

Returns:

the Notification object itself.

withOperator

public Notification withOperator(OperatorType operator)

Set the operator property: The comparison operator.

Parameters:

operator - the operator value to set.

Returns:

the Notification object itself.

withThreshold

public Notification withThreshold(BigDecimal threshold)

Set the threshold property: Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

Parameters:

threshold - the threshold value to set.

Returns:

the Notification object itself.

withThresholdType

public Notification withThresholdType(ThresholdType thresholdType)

Set the thresholdType property: The type of threshold.

Parameters:

thresholdType - the thresholdType value to set.

Returns:

the Notification object itself.