com.google.api.services.androidenterprise.model.Collection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-androidenterprise Show documentation
There is a newer version: v1-rev20250115-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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/google/apis-client-generator/
 * (build: 2016-07-08 17:28:43 UTC)
 * on 2016-10-11 at 14:14:59 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.androidenterprise.model;

/**
 * A collection resource defines a named set of apps that is visible to a set of users in the Google
 * Play Store app running on those users' managed devices. Those users can then install any of those
 * apps if they wish (which will trigger creation of install and entitlement resources). A user
 * cannot install an app on a managed device unless the app is listed in at least one collection
 * that is visible to that user.
 *
 * Note that the API can be used to directly install an app regardless of whether it is in any
 * collection - so an enterprise has a choice of either directly pushing apps to users, or allowing
 * users to install apps if they want. Which is appropriate will depend on the enterprise's policies
 * and the purpose of the apps concerned.
 *
 *  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 Google Play EMM 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 Collection extends com.google.api.client.json.GenericJson {

  /**
   * Arbitrary unique ID, allocated by the API on creation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String collectionId;

  /**
   * Identifies what kind of resource this is. Value: the fixed string
   * "androidenterprise#collection".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kind;

  /**
   * A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The IDs of the products in the collection, in the order in which they should be displayed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List productId;

  /**
   * Whether this collection is visible to all users, or only to the users that have been granted
   * access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet"
   * API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass
   * the "availableProductSet" for all users within a domain.
   *
   * The "allUsers" setting is deprecated, and will be removed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String visibility;

  /**
   * Arbitrary unique ID, allocated by the API on creation.
   * @return value or {@code null} for none
   */
  public java.lang.String getCollectionId() {
    return collectionId;
  }

  /**
   * Arbitrary unique ID, allocated by the API on creation.
   * @param collectionId collectionId or {@code null} for none
   */
  public Collection setCollectionId(java.lang.String collectionId) {
    this.collectionId = collectionId;
    return this;
  }

  /**
   * Identifies what kind of resource this is. Value: the fixed string
   * "androidenterprise#collection".
   * @return value or {@code null} for none
   */
  public java.lang.String getKind() {
    return kind;
  }

  /**
   * Identifies what kind of resource this is. Value: the fixed string
   * "androidenterprise#collection".
   * @param kind kind or {@code null} for none
   */
  public Collection setKind(java.lang.String kind) {
    this.kind = kind;
    return this;
  }

  /**
   * A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * A user-friendly name for the collection (should be unique), e.g. "Accounting apps".
   * @param name name or {@code null} for none
   */
  public Collection setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The IDs of the products in the collection, in the order in which they should be displayed.
   * @return value or {@code null} for none
   */
  public java.util.List getProductId() {
    return productId;
  }

  /**
   * The IDs of the products in the collection, in the order in which they should be displayed.
   * @param productId productId or {@code null} for none
   */
  public Collection setProductId(java.util.List productId) {
    this.productId = productId;
    return this;
  }

  /**
   * Whether this collection is visible to all users, or only to the users that have been granted
   * access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet"
   * API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass
   * the "availableProductSet" for all users within a domain.
   *
   * The "allUsers" setting is deprecated, and will be removed.
   * @return value or {@code null} for none
   */
  public java.lang.String getVisibility() {
    return visibility;
  }

  /**
   * Whether this collection is visible to all users, or only to the users that have been granted
   * access through the "Collectionviewers" API. With the launch of the "setAvailableProductSet"
   * API, this property should always be set to "viewersOnly", as the "allUsers" option will bypass
   * the "availableProductSet" for all users within a domain.
   *
   * The "allUsers" setting is deprecated, and will be removed.
   * @param visibility visibility or {@code null} for none
   */
  public Collection setVisibility(java.lang.String visibility) {
    this.visibility = visibility;
    return this;
  }

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

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

}