com.google.api.client.googleapis.notifications

Class AbstractNotification

java.lang.Object

com.google.api.client.googleapis.notifications.AbstractNotification

Direct Known Subclasses:

TypedNotification, UnparsedNotification

@Beta
public abstract class AbstractNotification
extends Object

Beta
Notification metadata sent to this client about a watched resource.

Implementation is not thread-safe.

Since:

1.16

Author:

Yaniv Inbar, Matthias Linder (mlinder)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNotification(AbstractNotification source) Copy constructor based on a source notification object.
protected	AbstractNotification(long messageNumber, String resourceState, String resourceId, String resourceUri, String channelId)

Method Summary

Methods

Modifier and Type	Method and Description
String	getChanged() Returns the type of change performed on the resource or null for none.
String	getChannelExpiration() Returns the notification channel expiration time or null for none.
String	getChannelId() Returns the notification channel UUID provided by the client in the watch request.
String	getChannelToken() Returns the notification channel token (an opaque string) provided by the client in the watch request or null for none.
long	getMessageNumber() Returns the message number (a monotonically increasing value starting with 1).
String	getResourceId() Returns the opaque ID for the watched resource that is stable across API versions.
String	getResourceState() Returns the resource state.
String	getResourceUri() Returns the opaque ID (in the form of a canonicalized URI) for the watched resource that is sensitive to the API version.
AbstractNotification	setChanged(String changed) Sets the type of change performed on the resource or null for none.
AbstractNotification	setChannelExpiration(String channelExpiration) Sets the notification channel expiration time or null for none.
AbstractNotification	setChannelId(String channelId) Sets the notification channel UUID provided by the client in the watch request.
AbstractNotification	setChannelToken(String channelToken) Sets the notification channel token (an opaque string) provided by the client in the watch request or null for none.
AbstractNotification	setMessageNumber(long messageNumber) Sets the message number (a monotonically increasing value starting with 1).
AbstractNotification	setResourceId(String resourceId) Sets the opaque ID for the watched resource that is stable across API versions.
AbstractNotification	setResourceState(String resourceState) Sets the resource state.
AbstractNotification	setResourceUri(String resourceUri) Sets the opaque ID (in the form of a canonicalized URI) for the watched resource that is sensitive to the API version.
String	toString()
protected com.google.api.client.util.Objects.ToStringHelper	toStringHelper() Returns the helper for toString().

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNotification

protected AbstractNotification(long messageNumber,
                    String resourceState,
                    String resourceId,
                    String resourceUri,
                    String channelId)

Parameters:

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

resourceState - resource state

resourceId - opaque ID for the watched resource that is stable across API versions

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

channelId - notification channel UUID provided by the client in the watch request

AbstractNotification

protected AbstractNotification(AbstractNotification source)

Copy constructor based on a source notification object.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

toStringHelper

protected com.google.api.client.util.Objects.ToStringHelper toStringHelper()

Returns the helper for toString().

getMessageNumber

public final long getMessageNumber()

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

setMessageNumber

public AbstractNotification setMessageNumber(long messageNumber)

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

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getResourceState

public final String getResourceState()

Returns the resource state.

setResourceState

public AbstractNotification setResourceState(String resourceState)

Sets the resource state.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getResourceId

public final String getResourceId()

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

setResourceId

public AbstractNotification setResourceId(String resourceId)

Sets the opaque ID for the watched resource that is stable across API versions.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getResourceUri

public final String getResourceUri()

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

setResourceUri

public AbstractNotification setResourceUri(String resourceUri)

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

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getChannelId

public final String getChannelId()

Returns the notification channel UUID provided by the client in the watch request.

setChannelId

public AbstractNotification setChannelId(String channelId)

Sets the notification channel UUID provided by the client in the watch request.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getChannelExpiration

public final String getChannelExpiration()

Returns the notification channel expiration time or null for none.

setChannelExpiration

public AbstractNotification setChannelExpiration(String channelExpiration)

Sets the notification channel expiration time or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getChannelToken

public final String getChannelToken()

Returns the notification channel token (an opaque string) provided by the client in the watch request or null for none.

setChannelToken

public AbstractNotification setChannelToken(String channelToken)

Sets the notification channel token (an opaque string) provided by the client in the watch request or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getChanged

public final String getChanged()

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

setChanged

public AbstractNotification setChanged(String changed)

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

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.