com.google.api.services.androidmanagement.v1.model.StartLostModeParams 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;

/**
 * Parameters associated with the START_LOST_MODE command to put the device into lost mode. At least
 * one of the parameters, not including the organization name, must be provided in order for the
 * device to be put into lost mode.
 *
 *  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 StartLostModeParams extends com.google.api.client.json.GenericJson {

  /**
   * The email address displayed to the user when the device is in lost mode.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String lostEmailAddress;

  /**
   * The message displayed to the user when the device is in lost mode.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private UserFacingMessage lostMessage;

  /**
   * The organization name displayed to the user when the device is in lost mode.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private UserFacingMessage lostOrganization;

  /**
   * The phone number that will be called when the device is in lost mode and the call owner button
   * is tapped.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private UserFacingMessage lostPhoneNumber;

  /**
   * The street address displayed to the user when the device is in lost mode.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private UserFacingMessage lostStreetAddress;

  /**
   * The email address displayed to the user when the device is in lost mode.
   * @return value or {@code null} for none
   */
  public java.lang.String getLostEmailAddress() {
    return lostEmailAddress;
  }

  /**
   * The email address displayed to the user when the device is in lost mode.
   * @param lostEmailAddress lostEmailAddress or {@code null} for none
   */
  public StartLostModeParams setLostEmailAddress(java.lang.String lostEmailAddress) {
    this.lostEmailAddress = lostEmailAddress;
    return this;
  }

  /**
   * The message displayed to the user when the device is in lost mode.
   * @return value or {@code null} for none
   */
  public UserFacingMessage getLostMessage() {
    return lostMessage;
  }

  /**
   * The message displayed to the user when the device is in lost mode.
   * @param lostMessage lostMessage or {@code null} for none
   */
  public StartLostModeParams setLostMessage(UserFacingMessage lostMessage) {
    this.lostMessage = lostMessage;
    return this;
  }

  /**
   * The organization name displayed to the user when the device is in lost mode.
   * @return value or {@code null} for none
   */
  public UserFacingMessage getLostOrganization() {
    return lostOrganization;
  }

  /**
   * The organization name displayed to the user when the device is in lost mode.
   * @param lostOrganization lostOrganization or {@code null} for none
   */
  public StartLostModeParams setLostOrganization(UserFacingMessage lostOrganization) {
    this.lostOrganization = lostOrganization;
    return this;
  }

  /**
   * The phone number that will be called when the device is in lost mode and the call owner button
   * is tapped.
   * @return value or {@code null} for none
   */
  public UserFacingMessage getLostPhoneNumber() {
    return lostPhoneNumber;
  }

  /**
   * The phone number that will be called when the device is in lost mode and the call owner button
   * is tapped.
   * @param lostPhoneNumber lostPhoneNumber or {@code null} for none
   */
  public StartLostModeParams setLostPhoneNumber(UserFacingMessage lostPhoneNumber) {
    this.lostPhoneNumber = lostPhoneNumber;
    return this;
  }

  /**
   * The street address displayed to the user when the device is in lost mode.
   * @return value or {@code null} for none
   */
  public UserFacingMessage getLostStreetAddress() {
    return lostStreetAddress;
  }

  /**
   * The street address displayed to the user when the device is in lost mode.
   * @param lostStreetAddress lostStreetAddress or {@code null} for none
   */
  public StartLostModeParams setLostStreetAddress(UserFacingMessage lostStreetAddress) {
    this.lostStreetAddress = lostStreetAddress;
    return this;
  }

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

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

}