com.google.api.services.androidenterprise.model.GroupLicense Maven / Gradle / Ivy
/*
* 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-09-27 at 15:47:22 UTC
* Modify at your own risk.
*/
package com.google.api.services.androidenterprise.model;
/**
* A group license object indicates a product that an enterprise admin has approved for use in the
* enterprise. The product may be free or paid. For free products, a group license object is created
* in these cases: if the enterprise admin approves a product in Google Play, if the product is
* added to a collection, or if an entitlement for the product is created for a user via the API.
* For paid products, a group license object is only created as part of the first bulk purchase of
* that product in Google Play by the enterprise admin.
*
* The API can be used to query group licenses; the available information includes the total number
* of licenses purchased (for paid products) and the total number of licenses that have been
* provisioned, that is, the total number of user entitlements in existence for the product.
*
* Group license objects are never deleted. If, for example, a free app is added to a collection and
* then removed, the group license will remain, allowing the enterprise admin to keep track of any
* remaining entitlements. An enterprise admin may indicate they are no longer interested in the
* group license by marking it as unapproved in Google Play.
*
* 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 GroupLicense extends com.google.api.client.json.GenericJson {
/**
* How this group license was acquired. "bulkPurchase" means that this group license object was
* created because the enterprise purchased licenses for this product; this is "free" otherwise
* (for free products).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String acquisitionKind;
/**
* Whether the product to which this group license relates is currently approved by the
* enterprise, as either "approved" or "unapproved". Products are approved when a group license is
* first created, but this approval may be revoked by an enterprise admin via Google Play.
* Unapproved products will not be visible to end users in collections and new entitlements to
* them should not normally be created.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String approval;
/**
* Identifies what kind of resource this is. Value: the fixed string
* "androidenterprise#groupLicense".
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String kind;
/**
* The total number of provisioned licenses for this product. Returned by read operations, but
* ignored in write operations.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer numProvisioned;
/**
* The number of purchased licenses (possibly in multiple purchases). If this field is omitted
* then there is no limit on the number of licenses that can be provisioned (e.g. if the
* acquisition kind is "free").
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer numPurchased;
/**
* The ID of the product that the license is for, e.g. "app:com.google.android.gm".
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String productId;
/**
* How this group license was acquired. "bulkPurchase" means that this group license object was
* created because the enterprise purchased licenses for this product; this is "free" otherwise
* (for free products).
* @return value or {@code null} for none
*/
public java.lang.String getAcquisitionKind() {
return acquisitionKind;
}
/**
* How this group license was acquired. "bulkPurchase" means that this group license object was
* created because the enterprise purchased licenses for this product; this is "free" otherwise
* (for free products).
* @param acquisitionKind acquisitionKind or {@code null} for none
*/
public GroupLicense setAcquisitionKind(java.lang.String acquisitionKind) {
this.acquisitionKind = acquisitionKind;
return this;
}
/**
* Whether the product to which this group license relates is currently approved by the
* enterprise, as either "approved" or "unapproved". Products are approved when a group license is
* first created, but this approval may be revoked by an enterprise admin via Google Play.
* Unapproved products will not be visible to end users in collections and new entitlements to
* them should not normally be created.
* @return value or {@code null} for none
*/
public java.lang.String getApproval() {
return approval;
}
/**
* Whether the product to which this group license relates is currently approved by the
* enterprise, as either "approved" or "unapproved". Products are approved when a group license is
* first created, but this approval may be revoked by an enterprise admin via Google Play.
* Unapproved products will not be visible to end users in collections and new entitlements to
* them should not normally be created.
* @param approval approval or {@code null} for none
*/
public GroupLicense setApproval(java.lang.String approval) {
this.approval = approval;
return this;
}
/**
* Identifies what kind of resource this is. Value: the fixed string
* "androidenterprise#groupLicense".
* @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#groupLicense".
* @param kind kind or {@code null} for none
*/
public GroupLicense setKind(java.lang.String kind) {
this.kind = kind;
return this;
}
/**
* The total number of provisioned licenses for this product. Returned by read operations, but
* ignored in write operations.
* @return value or {@code null} for none
*/
public java.lang.Integer getNumProvisioned() {
return numProvisioned;
}
/**
* The total number of provisioned licenses for this product. Returned by read operations, but
* ignored in write operations.
* @param numProvisioned numProvisioned or {@code null} for none
*/
public GroupLicense setNumProvisioned(java.lang.Integer numProvisioned) {
this.numProvisioned = numProvisioned;
return this;
}
/**
* The number of purchased licenses (possibly in multiple purchases). If this field is omitted
* then there is no limit on the number of licenses that can be provisioned (e.g. if the
* acquisition kind is "free").
* @return value or {@code null} for none
*/
public java.lang.Integer getNumPurchased() {
return numPurchased;
}
/**
* The number of purchased licenses (possibly in multiple purchases). If this field is omitted
* then there is no limit on the number of licenses that can be provisioned (e.g. if the
* acquisition kind is "free").
* @param numPurchased numPurchased or {@code null} for none
*/
public GroupLicense setNumPurchased(java.lang.Integer numPurchased) {
this.numPurchased = numPurchased;
return this;
}
/**
* The ID of the product that the license is for, e.g. "app:com.google.android.gm".
* @return value or {@code null} for none
*/
public java.lang.String getProductId() {
return productId;
}
/**
* The ID of the product that the license is for, e.g. "app:com.google.android.gm".
* @param productId productId or {@code null} for none
*/
public GroupLicense setProductId(java.lang.String productId) {
this.productId = productId;
return this;
}
@Override
public GroupLicense set(String fieldName, Object value) {
return (GroupLicense) super.set(fieldName, value);
}
@Override
public GroupLicense clone() {
return (GroupLicense) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy