com.google.api.client.googleapis.subscriptions

Class Notification

java.lang.Object

com.google.api.client.googleapis.subscriptions.Notification

Direct Known Subclasses:

TypedNotification, UnparsedNotification

public abstract class Notification
extends Object

Notification sent to this client about a subscribed resource.

Implementation is thread-safe.

Since:

1.14

Author:

Matthias Linder (mlinder)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Notification(Notification source) Creates a new notification by copying all information specified in the source notification.
protected	Notification(String subscriptionId, String topicId, String topicURI, String clientToken, long messageNumber, String eventType, String changeType)

Method Summary

Methods

Modifier and Type	Method and Description
String	getChangeType() Returns the type of change performed on the resource or null for none.
String	getClientToken() Returns the client token (an opaque string) or null for none.
String	getEventType() Returns the event type (see EventTypes).
long	getMessageNumber() Returns the message number (a monotonically increasing value starting with 1).
String	getSubscriptionId() Returns the subscription UUID.
String	getTopicId() Returns the opaque ID for the subscribed resource that is stable across API versions.
String	getTopicURI() Returns the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notification

protected Notification(String subscriptionId,
            String topicId,
            String topicURI,
            String clientToken,
            long messageNumber,
            String eventType,
            String changeType)

Parameters:

subscriptionId - subscription UUID

topicId - opaque ID for the subscribed resource that is stable across API versions

topicURI - opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version

clientToken - client token (an opaque string) or null for none

messageNumber - message number (a monotonically increasing value starting with 1)

eventType - event type (see EventTypes)

changeType - type of change performed on the resource or null for none

Notification

protected Notification(Notification source)

Creates a new notification by copying all information specified in the source notification.

Parameters:

source - notification whose information is copied

Method Detail

getSubscriptionId

public final String getSubscriptionId()

Returns the subscription UUID.

getTopicId

public final String getTopicId()

Returns the opaque ID for the subscribed resource that is stable across API versions.

getClientToken

public final String getClientToken()

Returns the client token (an opaque string) or null for none.

getEventType

public final String getEventType()

Returns the event type (see EventTypes).

getTopicURI

public final String getTopicURI()

Returns the opaque ID (in the form of a canonicalized URI) for the subscribed resource that is sensitive to the API version.

getMessageNumber

public final long getMessageNumber()

Returns the message number (a monotonically increasing value starting with 1).

getChangeType

public final String getChangeType()

Returns the type of change performed on the resource or null for none.