com.google.api.services.licensing

Class Licensing.LicenseAssignments.ListForProduct

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.licensing.LicensingRequest<LicenseAssignmentList>

com.google.api.services.licensing.Licensing.LicenseAssignments.ListForProduct

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Licensing.LicenseAssignments

public class Licensing.LicenseAssignments.ListForProduct
extends LicensingRequest<LicenseAssignmentList>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListForProduct(String productId, String customerId) List all users assigned licenses for a specific product SKU.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getCustomerId() The customer's unique ID as defined in the Admin console, such as `C00000000`.
Long	getMaxResults() The `maxResults` query string determines how many entries are returned on each page of a large response.
String	getPageToken() Token to fetch the next page of data.
String	getProductId() A product's unique identifier.
Licensing.LicenseAssignments.ListForProduct	set(String parameterName, Object value)
Licensing.LicenseAssignments.ListForProduct	set$Xgafv(String $Xgafv) V1 error format.
Licensing.LicenseAssignments.ListForProduct	setAccessToken(String accessToken) OAuth access token.
Licensing.LicenseAssignments.ListForProduct	setAlt(String alt) Data format for response.
Licensing.LicenseAssignments.ListForProduct	setCallback(String callback) JSONP
Licensing.LicenseAssignments.ListForProduct	setCustomerId(String customerId) The customer's unique ID as defined in the Admin console, such as `C00000000`.
Licensing.LicenseAssignments.ListForProduct	setFields(String fields) Selector specifying which fields to include in a partial response.
Licensing.LicenseAssignments.ListForProduct	setKey(String key) API key.
Licensing.LicenseAssignments.ListForProduct	setMaxResults(Long maxResults) The `maxResults` query string determines how many entries are returned on each page of a large response.
Licensing.LicenseAssignments.ListForProduct	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Licensing.LicenseAssignments.ListForProduct	setPageToken(String pageToken) Token to fetch the next page of data.
Licensing.LicenseAssignments.ListForProduct	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Licensing.LicenseAssignments.ListForProduct	setProductId(String productId) A product's unique identifier.
Licensing.LicenseAssignments.ListForProduct	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Licensing.LicenseAssignments.ListForProduct	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Licensing.LicenseAssignments.ListForProduct	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.licensing.LicensingRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

ListForProduct

protected ListForProduct(String productId,
                         String customerId)

List all users assigned licenses for a specific product SKU. Create a request for the method "licenseAssignments.listForProduct". This request holds the parameters needed by the the licensing server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

ListForProduct#initialize(com.google.api.client.googleapis.services.Abstr actGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

productId - A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

customerId - The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LicenseAssignmentList>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LicenseAssignmentList>

Throws:

IOException

set$Xgafv

public Licensing.LicenseAssignments.ListForProduct set$Xgafv(String $Xgafv)

Description copied from class: LicensingRequest

V1 error format.

Overrides:

set$Xgafv in class LicensingRequest<LicenseAssignmentList>

setAccessToken

public Licensing.LicenseAssignments.ListForProduct setAccessToken(String accessToken)

Description copied from class: LicensingRequest

OAuth access token.

Overrides:

setAccessToken in class LicensingRequest<LicenseAssignmentList>

setAlt

public Licensing.LicenseAssignments.ListForProduct setAlt(String alt)

Description copied from class: LicensingRequest

Data format for response.

Overrides:

setAlt in class LicensingRequest<LicenseAssignmentList>

setCallback

public Licensing.LicenseAssignments.ListForProduct setCallback(String callback)

Description copied from class: LicensingRequest

JSONP

Overrides:

setCallback in class LicensingRequest<LicenseAssignmentList>

setFields

public Licensing.LicenseAssignments.ListForProduct setFields(String fields)

Description copied from class: LicensingRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class LicensingRequest<LicenseAssignmentList>

setKey

public Licensing.LicenseAssignments.ListForProduct setKey(String key)

Description copied from class: LicensingRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class LicensingRequest<LicenseAssignmentList>

setOauthToken

public Licensing.LicenseAssignments.ListForProduct setOauthToken(String oauthToken)

Description copied from class: LicensingRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class LicensingRequest<LicenseAssignmentList>

setPrettyPrint

public Licensing.LicenseAssignments.ListForProduct setPrettyPrint(Boolean prettyPrint)

Description copied from class: LicensingRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class LicensingRequest<LicenseAssignmentList>

setQuotaUser

public Licensing.LicenseAssignments.ListForProduct setQuotaUser(String quotaUser)

Description copied from class: LicensingRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class LicensingRequest<LicenseAssignmentList>

setUploadType

public Licensing.LicenseAssignments.ListForProduct setUploadType(String uploadType)

Description copied from class: LicensingRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class LicensingRequest<LicenseAssignmentList>

setUploadProtocol

public Licensing.LicenseAssignments.ListForProduct setUploadProtocol(String uploadProtocol)

Description copied from class: LicensingRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class LicensingRequest<LicenseAssignmentList>

getProductId

public String getProductId()

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

setProductId

public Licensing.LicenseAssignments.ListForProduct setProductId(String productId)

A product's unique identifier. For more information about products in this version of the API, see Products and SKUs.

getCustomerId

public String getCustomerId()

The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error.

setCustomerId

public Licensing.LicenseAssignments.ListForProduct setCustomerId(String customerId)

The customer's unique ID as defined in the Admin console, such as `C00000000`. If the customer is suspended, the server returns an error.

getMaxResults

public Long getMaxResults()

The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number. [default: 100] [minimum: 1] [maximum: 1000]

setMaxResults

public Licensing.LicenseAssignments.ListForProduct setMaxResults(Long maxResults)

The `maxResults` query string determines how many entries are returned on each page of a large response. This is an optional parameter. The value must be a positive number.

getPageToken

public String getPageToken()

Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.

setPageToken

public Licensing.LicenseAssignments.ListForProduct setPageToken(String pageToken)

Token to fetch the next page of data. The `maxResults` query string is related to the `pageToken` since `maxResults` determines how many entries are returned on each page. This is an optional query string. If not specified, the server returns the first page.

set

public Licensing.LicenseAssignments.ListForProduct set(String parameterName,
                                                       Object value)

Overrides:

set in class LicensingRequest<LicenseAssignmentList>