com.google.api.client.googleapis.notifications

Class StoredChannel

java.lang.Object

com.google.api.client.googleapis.notifications.StoredChannel

All Implemented Interfaces:

java.io.Serializable

@Beta
public final class StoredChannel
extends java.lang.Object
implements java.io.Serializable

Beta
Notification channel information to be stored in a data store.

Implementation is thread safe.

Since:

1.16

Author:

Yaniv Inbar, Matthias Linder (mlinder)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_DATA_STORE_ID Default data store ID.

Constructor Summary

Constructors

Constructor and Description
StoredChannel(UnparsedNotificationCallback notificationCallback) Constructor with a random UUID using NotificationUtils.randomUuidString().
StoredChannel(UnparsedNotificationCallback notificationCallback, java.lang.String id) Constructor with a custom UUID.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.String	getClientToken() Returns the arbitrary string provided by the client associated with this subscription that is delivered to the target address with each notification or null for none.
static com.google.api.client.util.store.DataStore<StoredChannel>	getDefaultDataStore(com.google.api.client.util.store.DataStoreFactory dataStoreFactory) Returns the stored channel data store using the ID DEFAULT_DATA_STORE_ID.
java.lang.Long	getExpiration() Returns the milliseconds in Unix time at which the subscription will expire or null for an infinite TTL.
java.lang.String	getId() Returns the subscription UUID.
UnparsedNotificationCallback	getNotificationCallback() Returns the notification callback called when a notification is received for this subscription.
java.lang.String	getTopicId() Returns the opaque ID for the subscribed resource that is stable across API versions or null for none.
int	hashCode()
StoredChannel	setClientToken(java.lang.String clientToken) Sets the the arbitrary string provided by the client associated with this subscription that is delivered to the target address with each notification or null for none.
StoredChannel	setExpiration(java.lang.Long expiration) Sets the milliseconds in Unix time at which the subscription will expire or null for an infinite TTL.
StoredChannel	setTopicId(java.lang.String topicId) Sets the opaque ID for the subscribed resource that is stable across API versions or null for none.
StoredChannel	store(com.google.api.client.util.store.DataStore<StoredChannel> dataStore) Stores this notification channel in the given notification channel data store.
StoredChannel	store(com.google.api.client.util.store.DataStoreFactory dataStoreFactory) Stores this notification channel in the notification channel data store, which is derived from getDefaultDataStore(DataStoreFactory) on the given data store factory.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_DATA_STORE_ID

public static final java.lang.String DEFAULT_DATA_STORE_ID

Default data store ID.

Constructor Detail

StoredChannel

public StoredChannel(UnparsedNotificationCallback notificationCallback)

Constructor with a random UUID using NotificationUtils.randomUuidString().

Parameters:

notificationCallback - notification handler called when a notification is received for this subscription

StoredChannel

public StoredChannel(UnparsedNotificationCallback notificationCallback,
             java.lang.String id)

Constructor with a custom UUID.

Parameters:

notificationCallback - notification handler called when a notification is received for this subscription

id - subscription UUID

Method Detail

store

public StoredChannel store(com.google.api.client.util.store.DataStoreFactory dataStoreFactory)
                    throws java.io.IOException

Stores this notification channel in the notification channel data store, which is derived from getDefaultDataStore(DataStoreFactory) on the given data store factory.

It is important that this method be called before the watch HTTP request is made in case the notification is received before the watch HTTP response is received.

Parameters:

dataStoreFactory - data store factory

Throws:

java.io.IOException

store

public StoredChannel store(com.google.api.client.util.store.DataStore<StoredChannel> dataStore)
                    throws java.io.IOException

Stores this notification channel in the given notification channel data store.

It is important that this method be called before the watch HTTP request is made in case the notification is received before the watch HTTP response is received.

Parameters:

dataStore - notification channel data store

Throws:

java.io.IOException

getNotificationCallback

public UnparsedNotificationCallback getNotificationCallback()

Returns the notification callback called when a notification is received for this subscription.

getClientToken

public java.lang.String getClientToken()

Returns the arbitrary string provided by the client associated with this subscription that is delivered to the target address with each notification or null for none.

setClientToken

public StoredChannel setClientToken(java.lang.String clientToken)

Sets the the arbitrary string provided by the client associated with this subscription that is delivered to the target address with each notification or null for none.

getExpiration

public java.lang.Long getExpiration()

Returns the milliseconds in Unix time at which the subscription will expire or null for an infinite TTL.

setExpiration

public StoredChannel setExpiration(java.lang.Long expiration)

Sets the milliseconds in Unix time at which the subscription will expire or null for an infinite TTL.

getId

public java.lang.String getId()

Returns the subscription UUID.

getTopicId

public java.lang.String getTopicId()

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

setTopicId

public StoredChannel setTopicId(java.lang.String topicId)

Sets the opaque ID for the subscribed resource that is stable across API versions or null for none.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDefaultDataStore

public static com.google.api.client.util.store.DataStore<StoredChannel> getDefaultDataStore(com.google.api.client.util.store.DataStoreFactory dataStoreFactory)
                                                                                     throws java.io.IOException

Returns the stored channel data store using the ID DEFAULT_DATA_STORE_ID.

Parameters:

dataStoreFactory - data store factory

Returns:

stored channel data store

Throws:

java.io.IOException