Class AbstractNotification (2.1.2)

public abstract class AbstractNotification

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

Implementation is not thread-safe.

Inheritance

java.lang.Object > AbstractNotification

Constructors

AbstractNotification(AbstractNotification source)

protected AbstractNotification(AbstractNotification source)

Copy constructor based on a source notification object.

Parameter
NameDescription
sourceAbstractNotification

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

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

message number (a monotonically increasing value starting with 1)

resourceStateString
resource state
resourceIdString

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

resourceUriString

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

channelIdString

notification channel UUID provided by the client in the watch request

Methods

getChanged()

public final String getChanged()

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

Returns
TypeDescription
String

getChannelExpiration()

public final String getChannelExpiration()

Returns the notification channel expiration time or null for none.

Returns
TypeDescription
String

getChannelId()

public final String getChannelId()

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

Returns
TypeDescription
String

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.

Returns
TypeDescription
String

getMessageNumber()

public final long getMessageNumber()

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

Returns
TypeDescription
long

getResourceId()

public final String getResourceId()

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

Returns
TypeDescription
String

getResourceState()

public final String getResourceState()

Returns the resource state.

Returns
TypeDescription
String

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.

Returns
TypeDescription
String

setChanged(String changed)

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.

Parameter
NameDescription
changedString
Returns
TypeDescription
AbstractNotification

setChannelExpiration(String channelExpiration)

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.

Parameter
NameDescription
channelExpirationString
Returns
TypeDescription
AbstractNotification

setChannelId(String channelId)

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.

Parameter
NameDescription
channelIdString
Returns
TypeDescription
AbstractNotification

setChannelToken(String channelToken)

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.

Parameter
NameDescription
channelTokenString
Returns
TypeDescription
AbstractNotification

setMessageNumber(long messageNumber)

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.

Parameter
NameDescription
messageNumberlong
Returns
TypeDescription
AbstractNotification

setResourceId(String resourceId)

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.

Parameter
NameDescription
resourceIdString
Returns
TypeDescription
AbstractNotification

setResourceState(String resourceState)

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.

Parameter
NameDescription
resourceStateString
Returns
TypeDescription
AbstractNotification

setResourceUri(String resourceUri)

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.

Parameter
NameDescription
resourceUriString
Returns
TypeDescription
AbstractNotification

toString()

public String toString()
Returns
TypeDescription
String
Overrides

toStringHelper()

protected Objects.ToStringHelper toStringHelper()

Returns the helper for #toString().

Returns
TypeDescription
com.google.api.client.util.Objects.ToStringHelper