com.google.api.services.androidmanagement.v1.model.WebToken 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
The 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 web token used to access the managed Google Play iframe.
 *
 *  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 WebToken extends com.google.api.client.json.GenericJson {

  /**
   * The features to enable. Use this if you want to control exactly which feature(s) will be
   * activated; leave empty to allow all features.Restrictions / things to note: - If no features
   * are listed here, all features are enabled — this is the default behavior where you give access
   * to all features to your admins. - This must not contain any FEATURE_UNSPECIFIED values. -
   * Repeated values are ignored
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List enabledFeatures;

  /**
   * The name of the web token, which is generated by the server during creation in the form
   * enterprises/{enterpriseId}/webTokens/{webTokenId}.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe
   * may not be hosted at other URLs. The URL must use the https scheme.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String parentFrameUrl;

  /**
   * Permissions available to an admin in the embedded UI. An admin must have all of these
   * permissions in order to view the UI. This field is deprecated.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List permissions;

  /**
   * The token value which is used in the hosting page to generate the iframe with the embedded UI.
   * This is a read-only field generated by the server.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String value;

  /**
   * The features to enable. Use this if you want to control exactly which feature(s) will be
   * activated; leave empty to allow all features.Restrictions / things to note: - If no features
   * are listed here, all features are enabled — this is the default behavior where you give access
   * to all features to your admins. - This must not contain any FEATURE_UNSPECIFIED values. -
   * Repeated values are ignored
   * @return value or {@code null} for none
   */
  public java.util.List getEnabledFeatures() {
    return enabledFeatures;
  }

  /**
   * The features to enable. Use this if you want to control exactly which feature(s) will be
   * activated; leave empty to allow all features.Restrictions / things to note: - If no features
   * are listed here, all features are enabled — this is the default behavior where you give access
   * to all features to your admins. - This must not contain any FEATURE_UNSPECIFIED values. -
   * Repeated values are ignored
   * @param enabledFeatures enabledFeatures or {@code null} for none
   */
  public WebToken setEnabledFeatures(java.util.List enabledFeatures) {
    this.enabledFeatures = enabledFeatures;
    return this;
  }

  /**
   * The name of the web token, which is generated by the server during creation in the form
   * enterprises/{enterpriseId}/webTokens/{webTokenId}.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the web token, which is generated by the server during creation in the form
   * enterprises/{enterpriseId}/webTokens/{webTokenId}.
   * @param name name or {@code null} for none
   */
  public WebToken setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe
   * may not be hosted at other URLs. The URL must use the https scheme.
   * @return value or {@code null} for none
   */
  public java.lang.String getParentFrameUrl() {
    return parentFrameUrl;
  }

  /**
   * The URL of the parent frame hosting the iframe with the embedded UI. To prevent XSS, the iframe
   * may not be hosted at other URLs. The URL must use the https scheme.
   * @param parentFrameUrl parentFrameUrl or {@code null} for none
   */
  public WebToken setParentFrameUrl(java.lang.String parentFrameUrl) {
    this.parentFrameUrl = parentFrameUrl;
    return this;
  }

  /**
   * Permissions available to an admin in the embedded UI. An admin must have all of these
   * permissions in order to view the UI. This field is deprecated.
   * @return value or {@code null} for none
   */
  public java.util.List getPermissions() {
    return permissions;
  }

  /**
   * Permissions available to an admin in the embedded UI. An admin must have all of these
   * permissions in order to view the UI. This field is deprecated.
   * @param permissions permissions or {@code null} for none
   */
  public WebToken setPermissions(java.util.List permissions) {
    this.permissions = permissions;
    return this;
  }

  /**
   * The token value which is used in the hosting page to generate the iframe with the embedded UI.
   * This is a read-only field generated by the server.
   * @return value or {@code null} for none
   */
  public java.lang.String getValue() {
    return value;
  }

  /**
   * The token value which is used in the hosting page to generate the iframe with the embedded UI.
   * This is a read-only field generated by the server.
   * @param value value or {@code null} for none
   */
  public WebToken setValue(java.lang.String value) {
    this.value = value;
    return this;
  }

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

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

}