com.google.api.services.androidenterprise.model

Class GroupLicense

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.androidenterprise.model.GroupLicense

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GroupLicense
extends com.google.api.client.json.GenericJson

Group license objects allow you to keep track of licenses (called entitlements) for both free and paid apps. For a free app, a group license is created when an enterprise admin first approves the product in Google Play or when the first entitlement for the product is created for a user via the API. For a paid app, a group license object is only created when an enterprise admin purchases the product in Google Play for the first time. Use the API to query group licenses. A Grouplicenses resource includes the total number of licenses purchased (paid apps only) and the total number of licenses currently in use. In other words, the total number of Entitlements that exist for the product. Only one group license object is created per product and group license objects are never deleted. If a product is unapproved, its group license remains. This allows enterprise admins to keep track of any remaining entitlements for the product.

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GroupLicense()

Method Summary

Modifier and Type	Method and Description
GroupLicense	clone()
String	getAcquisitionKind() How this group license was acquired.
String	getApproval() Whether the product to which this group license relates is currently approved by the enterprise.
String	getKind() Identifies what kind of resource this is.
Integer	getNumProvisioned() The total number of provisioned licenses for this product.
Integer	getNumPurchased() The number of purchased licenses (possibly in multiple purchases).
String	getPermissions() The permission approval status of the product.
String	getProductId() The ID of the product that the license is for.
GroupLicense	set(String fieldName, Object value)
GroupLicense	setAcquisitionKind(String acquisitionKind) How this group license was acquired.
GroupLicense	setApproval(String approval) Whether the product to which this group license relates is currently approved by the enterprise.
GroupLicense	setKind(String kind) Identifies what kind of resource this is.
GroupLicense	setNumProvisioned(Integer numProvisioned) The total number of provisioned licenses for this product.
GroupLicense	setNumPurchased(Integer numPurchased) The number of purchased licenses (possibly in multiple purchases).
GroupLicense	setPermissions(String permissions) The permission approval status of the product.
GroupLicense	setProductId(String productId) The ID of the product that the license is for.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GroupLicense

public GroupLicense()

Method Detail

getAcquisitionKind

public String getAcquisitionKind()

How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).

Returns:

value or null for none

setAcquisitionKind

public GroupLicense setAcquisitionKind(String acquisitionKind)

How this group license was acquired. "bulkPurchase" means that this Grouplicenses resource was created because the enterprise purchased licenses for this product; otherwise, the value is "free" (for free products).

Parameters:

acquisitionKind - acquisitionKind or null for none

getApproval

public String getApproval()

Whether the product to which this group license relates is currently approved by the enterprise. 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.

Returns:

value or null for none

setApproval

public GroupLicense setApproval(String approval)

Whether the product to which this group license relates is currently approved by the enterprise. 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.

Parameters:

approval - approval or null for none

getKind

public String getKind()

Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".

Returns:

value or null for none

setKind

public GroupLicense setKind(String kind)

Identifies what kind of resource this is. Value: the fixed string "androidenterprise#groupLicense".

Parameters:

kind - kind or null for none

getNumProvisioned

public Integer getNumProvisioned()

The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.

Returns:

value or null for none

setNumProvisioned

public GroupLicense setNumProvisioned(Integer numProvisioned)

The total number of provisioned licenses for this product. Returned by read operations, but ignored in write operations.

Parameters:

numProvisioned - numProvisioned or null for none

getNumPurchased

public Integer getNumPurchased()

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 (for example, if the acquisition kind is "free").

Returns:

value or null for none

setNumPurchased

public GroupLicense setNumPurchased(Integer 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 (for example, if the acquisition kind is "free").

Parameters:

numPurchased - numPurchased or null for none

getPermissions

public String getPermissions()

The permission approval status of the product. This field is only set if the product is approved. Possible states are: - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.

Returns:

value or null for none

setPermissions

public GroupLicense setPermissions(String permissions)

The permission approval status of the product. This field is only set if the product is approved. Possible states are: - "currentApproved", the current set of permissions is approved, but additional permissions will require the administrator to reapprove the product (If the product was approved without specifying the approved permissions setting, then this is the default behavior.), - "needsReapproval", the product has unapproved permissions. No additional product licenses can be assigned until the product is reapproved, - "allCurrentAndFutureApproved", the current permissions are approved and any future permission updates will be automatically approved without administrator review.

Parameters:

permissions - permissions or null for none

getProductId

public String getProductId()

The ID of the product that the license is for. For example, "app:com.google.android.gm".

Returns:

value or null for none

setProductId

public GroupLicense setProductId(String productId)

The ID of the product that the license is for. For example, "app:com.google.android.gm".

Parameters:

productId - productId or null for none

set

public GroupLicense set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GroupLicense clone()

Overrides:

clone in class com.google.api.client.json.GenericJson