com.google.api.services.androidenterprise

Class AndroidEnterprise.Enterprises.PullNotificationSet

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.androidenterprise.AndroidEnterpriseRequest<NotificationSet>

com.google.api.services.androidenterprise.AndroidEnterprise.Enterprises.PullNotificationSet

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AndroidEnterprise.Enterprises

public class AndroidEnterprise.Enterprises.PullNotificationSet
extends AndroidEnterpriseRequest<NotificationSet>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PullNotificationSet() Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request.

Method Summary

Modifier and Type	Method and Description
String	getRequestMode() The request mode for pulling notifications.
AndroidEnterprise.Enterprises.PullNotificationSet	set(String parameterName, Object value)
AndroidEnterprise.Enterprises.PullNotificationSet	setAlt(String alt) Data format for the response.
AndroidEnterprise.Enterprises.PullNotificationSet	setFields(String fields) Selector specifying which fields to include in a partial response.
AndroidEnterprise.Enterprises.PullNotificationSet	setKey(String key) API key.
AndroidEnterprise.Enterprises.PullNotificationSet	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AndroidEnterprise.Enterprises.PullNotificationSet	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AndroidEnterprise.Enterprises.PullNotificationSet	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
AndroidEnterprise.Enterprises.PullNotificationSet	setRequestMode(String requestMode) The request mode for pulling notifications.
AndroidEnterprise.Enterprises.PullNotificationSet	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.androidenterprise.AndroidEnterpriseRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

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

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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

PullNotificationSet

protected PullNotificationSet()

Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available. Create a request for the method "enterprises.pullNotificationSet". This request holds the parameters needed by the the androidenterprise server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

PullNotificationSet#initialize(com.google.api.client.googleapis.se rvices.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Since:

1.13

Method Detail

setAlt

public AndroidEnterprise.Enterprises.PullNotificationSet setAlt(String alt)

Description copied from class: AndroidEnterpriseRequest

Data format for the response.

Overrides:

setAlt in class AndroidEnterpriseRequest<NotificationSet>

setFields

public AndroidEnterprise.Enterprises.PullNotificationSet setFields(String fields)

Description copied from class: AndroidEnterpriseRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AndroidEnterpriseRequest<NotificationSet>

setKey

public AndroidEnterprise.Enterprises.PullNotificationSet setKey(String key)

Description copied from class: AndroidEnterpriseRequest

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 AndroidEnterpriseRequest<NotificationSet>

setOauthToken

public AndroidEnterprise.Enterprises.PullNotificationSet setOauthToken(String oauthToken)

Description copied from class: AndroidEnterpriseRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AndroidEnterpriseRequest<NotificationSet>

setPrettyPrint

public AndroidEnterprise.Enterprises.PullNotificationSet setPrettyPrint(Boolean prettyPrint)

Description copied from class: AndroidEnterpriseRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AndroidEnterpriseRequest<NotificationSet>

setQuotaUser

public AndroidEnterprise.Enterprises.PullNotificationSet setQuotaUser(String quotaUser)

Description copied from class: AndroidEnterpriseRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class AndroidEnterpriseRequest<NotificationSet>

setUserIp

public AndroidEnterprise.Enterprises.PullNotificationSet setUserIp(String userIp)

Description copied from class: AndroidEnterpriseRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class AndroidEnterpriseRequest<NotificationSet>

getRequestMode

public String getRequestMode()

The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.

setRequestMode

public AndroidEnterprise.Enterprises.PullNotificationSet setRequestMode(String requestMode)

The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications.

set

public AndroidEnterprise.Enterprises.PullNotificationSet set(String parameterName,
                                                             Object value)

Overrides:

set in class AndroidEnterpriseRequest<NotificationSet>