/*
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.billingbudgets.v1.model;

/**
 * NotificationsRule defines notifications that are sent based on budget spend and thresholds.
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Billing Budget API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudBillingBudgetsV1NotificationsRule extends com.google.api.client.json.GenericJson {

  /**
   * Optional. When set to true, disables default notifications sent when a threshold is exceeded.
   * Default notifications are sent to those with Billing Account Administrator and Billing Account
   * User IAM roles for the target account.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean disableDefaultIamRecipients;

  /**
   * Optional. When set to true, and when the budget has a single project configured, notifications
   * will be sent to project level recipients of that project. This field will be ignored if the
   * budget has multiple or no project configured. Currently, project level recipients are the users
   * with `Owner` role on a cloud project.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enableProjectLevelRecipients;

  /**
   * Optional. Email targets to send notifications to when a threshold is exceeded. This is in
   * addition to the `DefaultIamRecipients` who receive alert emails based on their billing account
   * IAM role. The value is the full REST resource name of a Cloud Monitoring email notification
   * channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5
   * email notifications are allowed. To customize budget alert email recipients with monitoring
   * notification channels, you _must create the monitoring notification channels before you link
   * them to a budget_. For guidance on setting up notification channels to use with budgets, see
   * [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-
   * notification-recipients). For Cloud Billing budget alerts, you _must use email notification
   * channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or
   * PagerDuty. If you want to [send budget notifications to
   * Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a
   * pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs
   * /how-to/budgets-programmatic-notifications).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> monitoringNotificationChannels;

  /**
   * Optional. The name of the Pub/Sub topic where budget-related messages are published, in the
   * form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular
   * intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule)
   * you've set. Note that if you want your [Pub/Sub JSON
   * object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at
   * least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also
   * enable at least one of the email notification options, either using the default IAM recipients
   * or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must
   * do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For
   * guidance, see [Manage programmatic budget alert
   * notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the
   * Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on
   * Pub/Sub roles and permissions, see [Permissions required for this
   * task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#permissions_required_for_this_task).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pubsubTopic;

  /**
   * Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the
   * notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the
   * JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#notification_format.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String schemaVersion;

  /**
   * Optional. When set to true, disables default notifications sent when a threshold is exceeded.
   * Default notifications are sent to those with Billing Account Administrator and Billing Account
   * User IAM roles for the target account.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDisableDefaultIamRecipients() {
    return disableDefaultIamRecipients;
  }

  /**
   * Optional. When set to true, disables default notifications sent when a threshold is exceeded.
   * Default notifications are sent to those with Billing Account Administrator and Billing Account
   * User IAM roles for the target account.
   * @param disableDefaultIamRecipients disableDefaultIamRecipients or {@code null} for none
   */
  public GoogleCloudBillingBudgetsV1NotificationsRule setDisableDefaultIamRecipients(java.lang.Boolean disableDefaultIamRecipients) {
    this.disableDefaultIamRecipients = disableDefaultIamRecipients;
    return this;
  }

  /**
   * Optional. When set to true, and when the budget has a single project configured, notifications
   * will be sent to project level recipients of that project. This field will be ignored if the
   * budget has multiple or no project configured. Currently, project level recipients are the users
   * with `Owner` role on a cloud project.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnableProjectLevelRecipients() {
    return enableProjectLevelRecipients;
  }

  /**
   * Optional. When set to true, and when the budget has a single project configured, notifications
   * will be sent to project level recipients of that project. This field will be ignored if the
   * budget has multiple or no project configured. Currently, project level recipients are the users
   * with `Owner` role on a cloud project.
   * @param enableProjectLevelRecipients enableProjectLevelRecipients or {@code null} for none
   */
  public GoogleCloudBillingBudgetsV1NotificationsRule setEnableProjectLevelRecipients(java.lang.Boolean enableProjectLevelRecipients) {
    this.enableProjectLevelRecipients = enableProjectLevelRecipients;
    return this;
  }

  /**
   * Optional. Email targets to send notifications to when a threshold is exceeded. This is in
   * addition to the `DefaultIamRecipients` who receive alert emails based on their billing account
   * IAM role. The value is the full REST resource name of a Cloud Monitoring email notification
   * channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5
   * email notifications are allowed. To customize budget alert email recipients with monitoring
   * notification channels, you _must create the monitoring notification channels before you link
   * them to a budget_. For guidance on setting up notification channels to use with budgets, see
   * [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-
   * notification-recipients). For Cloud Billing budget alerts, you _must use email notification
   * channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or
   * PagerDuty. If you want to [send budget notifications to
   * Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a
   * pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs
   * /how-to/budgets-programmatic-notifications).
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getMonitoringNotificationChannels() {
    return monitoringNotificationChannels;
  }

  /**
   * Optional. Email targets to send notifications to when a threshold is exceeded. This is in
   * addition to the `DefaultIamRecipients` who receive alert emails based on their billing account
   * IAM role. The value is the full REST resource name of a Cloud Monitoring email notification
   * channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5
   * email notifications are allowed. To customize budget alert email recipients with monitoring
   * notification channels, you _must create the monitoring notification channels before you link
   * them to a budget_. For guidance on setting up notification channels to use with budgets, see
   * [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-
   * notification-recipients). For Cloud Billing budget alerts, you _must use email notification
   * channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or
   * PagerDuty. If you want to [send budget notifications to
   * Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a
   * pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs
   * /how-to/budgets-programmatic-notifications).
   * @param monitoringNotificationChannels monitoringNotificationChannels or {@code null} for none
   */
  public GoogleCloudBillingBudgetsV1NotificationsRule setMonitoringNotificationChannels(java.util.List<java.lang.String> monitoringNotificationChannels) {
    this.monitoringNotificationChannels = monitoringNotificationChannels;
    return this;
  }

  /**
   * Optional. The name of the Pub/Sub topic where budget-related messages are published, in the
   * form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular
   * intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule)
   * you've set. Note that if you want your [Pub/Sub JSON
   * object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at
   * least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also
   * enable at least one of the email notification options, either using the default IAM recipients
   * or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must
   * do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For
   * guidance, see [Manage programmatic budget alert
   * notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the
   * Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on
   * Pub/Sub roles and permissions, see [Permissions required for this
   * task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#permissions_required_for_this_task).
   * @return value or {@code null} for none
   */
  public java.lang.String getPubsubTopic() {
    return pubsubTopic;
  }

  /**
   * Optional. The name of the Pub/Sub topic where budget-related messages are published, in the
   * form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular
   * intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule)
   * you've set. Note that if you want your [Pub/Sub JSON
   * object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at
   * least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also
   * enable at least one of the email notification options, either using the default IAM recipients
   * or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must
   * do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For
   * guidance, see [Manage programmatic budget alert
   * notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the
   * Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on
   * Pub/Sub roles and permissions, see [Permissions required for this
   * task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#permissions_required_for_this_task).
   * @param pubsubTopic pubsubTopic or {@code null} for none
   */
  public GoogleCloudBillingBudgetsV1NotificationsRule setPubsubTopic(java.lang.String pubsubTopic) {
    this.pubsubTopic = pubsubTopic;
    return this;
  }

  /**
   * Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the
   * notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the
   * JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#notification_format.
   * @return value or {@code null} for none
   */
  public java.lang.String getSchemaVersion() {
    return schemaVersion;
  }

  /**
   * Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the
   * notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the
   * JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
   * notifications#notification_format.
   * @param schemaVersion schemaVersion or {@code null} for none
   */
  public GoogleCloudBillingBudgetsV1NotificationsRule setSchemaVersion(java.lang.String schemaVersion) {
    this.schemaVersion = schemaVersion;
    return this;
  }

  @Override
  public GoogleCloudBillingBudgetsV1NotificationsRule set(String fieldName, Object value) {
    return (GoogleCloudBillingBudgetsV1NotificationsRule) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudBillingBudgetsV1NotificationsRule clone() {
    return (GoogleCloudBillingBudgetsV1NotificationsRule) super.clone();
  }

}
