com.google.api.services.androidmanagement.v1.model.PolicyEnforcementRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-androidmanagement Show documentation
There is a newer version: v1-rev20241204-2.0.0
Show newest version
/*
 * 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.androidmanagement.v1.model;

/**
 * A rule that defines the actions to take if a device or work profile is not compliant with the
 * policy specified in settingName. In the case of multiple matching or multiple triggered
 * enforcement rules, a merge will occur with the most severe action being taken. However, all
 * triggered rules are still kept track of: this includes initial trigger time and all associated
 * non-compliance details. In the situation where the most severe enforcement rule is satisfied, the
 * next most appropriate action is applied.
 *
 *  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 Android Management API. For a detailed explanation
 * see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class PolicyEnforcementRule extends com.google.api.client.json.GenericJson {

  /**
   * An action to block access to apps and data on a company owned device or in a work profile. This
   * action also triggers a user-facing notification with information (where possible) on how to
   * correct the compliance issue. Note: wipeAction must also be specified.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private BlockAction blockAction;

  /**
   * The top-level policy to enforce. For example, applications or passwordPolicies.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String settingName;

  /**
   * An action to reset a company owned device or delete a work profile. Note: blockAction must also
   * be specified.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private WipeAction wipeAction;

  /**
   * An action to block access to apps and data on a company owned device or in a work profile. This
   * action also triggers a user-facing notification with information (where possible) on how to
   * correct the compliance issue. Note: wipeAction must also be specified.
   * @return value or {@code null} for none
   */
  public BlockAction getBlockAction() {
    return blockAction;
  }

  /**
   * An action to block access to apps and data on a company owned device or in a work profile. This
   * action also triggers a user-facing notification with information (where possible) on how to
   * correct the compliance issue. Note: wipeAction must also be specified.
   * @param blockAction blockAction or {@code null} for none
   */
  public PolicyEnforcementRule setBlockAction(BlockAction blockAction) {
    this.blockAction = blockAction;
    return this;
  }

  /**
   * The top-level policy to enforce. For example, applications or passwordPolicies.
   * @return value or {@code null} for none
   */
  public java.lang.String getSettingName() {
    return settingName;
  }

  /**
   * The top-level policy to enforce. For example, applications or passwordPolicies.
   * @param settingName settingName or {@code null} for none
   */
  public PolicyEnforcementRule setSettingName(java.lang.String settingName) {
    this.settingName = settingName;
    return this;
  }

  /**
   * An action to reset a company owned device or delete a work profile. Note: blockAction must also
   * be specified.
   * @return value or {@code null} for none
   */
  public WipeAction getWipeAction() {
    return wipeAction;
  }

  /**
   * An action to reset a company owned device or delete a work profile. Note: blockAction must also
   * be specified.
   * @param wipeAction wipeAction or {@code null} for none
   */
  public PolicyEnforcementRule setWipeAction(WipeAction wipeAction) {
    this.wipeAction = wipeAction;
    return this;
  }

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

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

}