com.google.api.client.googleapis.subscriptions

Class SubscribeRequest

java.lang.Object

com.google.api.client.googleapis.subscriptions.SubscribeRequest

Direct Known Subclasses:

JsonSubscribeRequest

public class SubscribeRequest
extends Object

Subscribe request.

Implementation is not thread-safe.

Since:

1.14

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
SubscribeRequest(com.google.api.client.http.HttpRequest request, String notificationDeliveryMethod)

Method Summary

Methods

Modifier and Type	Method and Description
SubscribeResponse	execute() Executes the subscribe request.
String	getClientToken() Returns the client token (an opaque string) provided by the client or null for none.
NotificationCallback	getNotificationCallback() Returns the notification callback or null for none.
String	getNotificationDeliveryMethod() Returns the notifications delivery method.
com.google.api.client.http.HttpRequest	getRequest() Returns the subscribe HTTP request.
String	getSubscriptionId() Returns the subscription UUID provided by the client.
SubscriptionStore	getSubscriptionStore() Returns the subscription store or null for none.
<E> void	queue(BatchRequest batchRequest, Class<E> errorClass, BatchCallback<Void,E> callback) Queues the subscribe request into the specified batch request container.
SubscribeRequest	setClientToken(String clientToken) Sets the client token (an opaque string) provided by the client or null for none.
SubscribeRequest	setNotificationDeliveryMethod(String notificationDeliveryMethod) Sets the notifications delivery method.
SubscribeRequest	setSubscriptionId(String subscriptionId) Sets the subscription UUID provided by the client.
SubscribeRequest	withNotificationCallback(SubscriptionStore subscriptionStore, NotificationCallback notificationCallback) Sets the subscription store and notification callback associated with this subscription.
<N> SubscribeRequest	withTypedNotificationCallback(SubscriptionStore subscriptionStore, Class<N> notificationCallbackClass, TypedNotificationCallback<N> typedNotificationCallback) Sets the subscription store and typed notification callback associated with this subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscribeRequest

public SubscribeRequest(com.google.api.client.http.HttpRequest request,
                String notificationDeliveryMethod)

Parameters:

request - HTTP GET request

notificationDeliveryMethod - notification delivery method

Method Detail

withNotificationCallback

public SubscribeRequest withNotificationCallback(SubscriptionStore subscriptionStore,
                                        NotificationCallback notificationCallback)

Sets the subscription store and notification callback associated with this subscription.

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

Parameters:

subscriptionStore - subscription store

notificationCallback - notification callback

withTypedNotificationCallback

public <N> SubscribeRequest withTypedNotificationCallback(SubscriptionStore subscriptionStore,
                                                 Class<N> notificationCallbackClass,
                                                 TypedNotificationCallback<N> typedNotificationCallback)

Sets the subscription store and typed notification callback associated with this subscription.

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

Parameters:

subscriptionStore - subscription store

notificationCallbackClass - data class the successful notification will be parsed into or Void.class to ignore the content

typedNotificationCallback - typed notification callback

getRequest

public final com.google.api.client.http.HttpRequest getRequest()

Returns the subscribe HTTP request.

getNotificationDeliveryMethod

public final String getNotificationDeliveryMethod()

Returns the notifications delivery method.

setNotificationDeliveryMethod

public SubscribeRequest setNotificationDeliveryMethod(String notificationDeliveryMethod)

Sets the notifications delivery method.

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

getNotificationCallback

public final NotificationCallback getNotificationCallback()

Returns the notification callback or null for none.

getSubscriptionStore

public final SubscriptionStore getSubscriptionStore()

Returns the subscription store or null for none.

getClientToken

public String getClientToken()

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

setClientToken

public SubscribeRequest setClientToken(String clientToken)

Sets the client token (an opaque string) provided by the client or null for none.

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

getSubscriptionId

public String getSubscriptionId()

Returns the subscription UUID provided by the client.

setSubscriptionId

public SubscribeRequest setSubscriptionId(String subscriptionId)

Sets the subscription UUID provided by the client.

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

execute

public SubscribeResponse execute()
                          throws IOException

Executes the subscribe request.

Returns:

subscribe response

Throws:

IOException

queue

public final <E> void queue(BatchRequest batchRequest,
             Class<E> errorClass,
             BatchCallback<Void,E> callback)
                 throws IOException

Queues the subscribe request into the specified batch request container.

Batched requests are then executed when BatchRequest.execute() is called.

Parameters:

batchRequest - batch request container

errorClass - data class the unsuccessful response will be parsed into or Void.class to ignore the content

callback - batch callback

Throws:

IOException