/*
 * 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.contentwarehouse.v1.model;

/**
 * Capability with regard to support of alarms by the client.
 *
 * <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 Document AI Warehouse 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 AssistantDevicesPlatformProtoAlarmCapability extends com.google.api.client.json.GenericJson {

  /**
   * Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum
   * limit.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer maxSupportedAlarms;

  /**
   * Whether the client restricts alarms to ring within the next 24 hours.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean restrictAlarmsToNextDay;

  /**
   * Whether the client supports mutation of any alarm attribute such as time_pattern,
   * recurrence_pattern, etc through the MUTATE action. If this is false, MUTATE may only be used to
   * disable or dismiss an alarm. This field is true by default for backwards-compatibility; clients
   * which don't support mutation outside of Disable/DismissAlarm should explicitly set this to
   * false.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean supportsGenericMutations;

  /**
   * Whether the client supports the STOP alarm action. If this is false, stop actions will be
   * represented by the MUTATE action, and the device may need to check alarm state to determine if
   * there's a firing alarm that needs to be dismissed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean supportsStopAction;

  /**
   * Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum
   * limit.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMaxSupportedAlarms() {
    return maxSupportedAlarms;
  }

  /**
   * Maximum number of alarms that can be created on the client. Zero or unset indicates no maximum
   * limit.
   * @param maxSupportedAlarms maxSupportedAlarms or {@code null} for none
   */
  public AssistantDevicesPlatformProtoAlarmCapability setMaxSupportedAlarms(java.lang.Integer maxSupportedAlarms) {
    this.maxSupportedAlarms = maxSupportedAlarms;
    return this;
  }

  /**
   * Whether the client restricts alarms to ring within the next 24 hours.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getRestrictAlarmsToNextDay() {
    return restrictAlarmsToNextDay;
  }

  /**
   * Whether the client restricts alarms to ring within the next 24 hours.
   * @param restrictAlarmsToNextDay restrictAlarmsToNextDay or {@code null} for none
   */
  public AssistantDevicesPlatformProtoAlarmCapability setRestrictAlarmsToNextDay(java.lang.Boolean restrictAlarmsToNextDay) {
    this.restrictAlarmsToNextDay = restrictAlarmsToNextDay;
    return this;
  }

  /**
   * Whether the client supports mutation of any alarm attribute such as time_pattern,
   * recurrence_pattern, etc through the MUTATE action. If this is false, MUTATE may only be used to
   * disable or dismiss an alarm. This field is true by default for backwards-compatibility; clients
   * which don't support mutation outside of Disable/DismissAlarm should explicitly set this to
   * false.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSupportsGenericMutations() {
    return supportsGenericMutations;
  }

  /**
   * Whether the client supports mutation of any alarm attribute such as time_pattern,
   * recurrence_pattern, etc through the MUTATE action. If this is false, MUTATE may only be used to
   * disable or dismiss an alarm. This field is true by default for backwards-compatibility; clients
   * which don't support mutation outside of Disable/DismissAlarm should explicitly set this to
   * false.
   * @param supportsGenericMutations supportsGenericMutations or {@code null} for none
   */
  public AssistantDevicesPlatformProtoAlarmCapability setSupportsGenericMutations(java.lang.Boolean supportsGenericMutations) {
    this.supportsGenericMutations = supportsGenericMutations;
    return this;
  }

  /**
   * Whether the client supports the STOP alarm action. If this is false, stop actions will be
   * represented by the MUTATE action, and the device may need to check alarm state to determine if
   * there's a firing alarm that needs to be dismissed.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getSupportsStopAction() {
    return supportsStopAction;
  }

  /**
   * Whether the client supports the STOP alarm action. If this is false, stop actions will be
   * represented by the MUTATE action, and the device may need to check alarm state to determine if
   * there's a firing alarm that needs to be dismissed.
   * @param supportsStopAction supportsStopAction or {@code null} for none
   */
  public AssistantDevicesPlatformProtoAlarmCapability setSupportsStopAction(java.lang.Boolean supportsStopAction) {
    this.supportsStopAction = supportsStopAction;
    return this;
  }

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

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

}
