com.google.api.services.pubsub

Class Pubsub.Subscriptions

java.lang.Object

com.google.api.services.pubsub.Pubsub.Subscriptions

Enclosing class:

Pubsub

public class Pubsub.Subscriptions
extends java.lang.Object

The "subscriptions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Pubsub.Subscriptions.Acknowledge
class	Pubsub.Subscriptions.Create
class	Pubsub.Subscriptions.Delete
class	Pubsub.Subscriptions.Get
class	Pubsub.Subscriptions.List
class	Pubsub.Subscriptions.ModifyAckDeadline
class	Pubsub.Subscriptions.ModifyPushConfig
class	Pubsub.Subscriptions.Pull
class	Pubsub.Subscriptions.PullBatch

Constructor Summary

Constructors

Constructor and Description
Subscriptions()

Method Summary

Modifier and Type	Method and Description
Pubsub.Subscriptions.Acknowledge	acknowledge(AcknowledgeRequest content) Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription.
Pubsub.Subscriptions.Create	create(Subscription content) Creates a subscription on a given topic for a given subscriber.
Pubsub.Subscriptions.Delete	delete(java.lang.String subscription) Deletes an existing subscription.
Pubsub.Subscriptions.Get	get(java.lang.String subscription) Gets the configuration details of a subscription.
Pubsub.Subscriptions.List	list() Lists matching subscriptions.
Pubsub.Subscriptions.ModifyAckDeadline	modifyAckDeadline(ModifyAckDeadlineRequest content) Modifies the Ack deadline for a message received from a pull request.
Pubsub.Subscriptions.ModifyPushConfig	modifyPushConfig(ModifyPushConfigRequest content) Modifies the PushConfig for a specified subscription.
Pubsub.Subscriptions.Pull	pull(PullRequest content) Pulls a single message from the server.
Pubsub.Subscriptions.PullBatch	pullBatch(PullBatchRequest content) Pulls messages from the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Subscriptions

public Subscriptions()

Method Detail

acknowledge

public Pubsub.Subscriptions.Acknowledge acknowledge(AcknowledgeRequest content)
                                             throws java.io.IOException

Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull. Create a request for the method "subscriptions.acknowledge". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the AcknowledgeRequest

Returns:

the request

Throws:

java.io.IOException

create

public Pubsub.Subscriptions.Create create(Subscription content)
                                   throws java.io.IOException

Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. Create a request for the method "subscriptions.create". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the Subscription

Returns:

the request

Throws:

java.io.IOException

delete

public Pubsub.Subscriptions.Delete delete(java.lang.String subscription)
                                   throws java.io.IOException

Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. Create a request for the method "subscriptions.delete". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

subscription - The subscription to delete.

Returns:

the request

Throws:

java.io.IOException

get

public Pubsub.Subscriptions.Get get(java.lang.String subscription)
                             throws java.io.IOException

Gets the configuration details of a subscription. Create a request for the method "subscriptions.get". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

subscription - The name of the subscription to get.

Returns:

the request

Throws:

java.io.IOException

list

public Pubsub.Subscriptions.List list()
                               throws java.io.IOException

Lists matching subscriptions. Create a request for the method "subscriptions.list". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

java.io.IOException

modifyAckDeadline

public Pubsub.Subscriptions.ModifyAckDeadline modifyAckDeadline(ModifyAckDeadlineRequest content)
                                                         throws java.io.IOException

Modifies the Ack deadline for a message received from a pull request. Create a request for the method "subscriptions.modifyAckDeadline". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the ModifyAckDeadlineRequest

Returns:

the request

Throws:

java.io.IOException

modifyPushConfig

public Pubsub.Subscriptions.ModifyPushConfig modifyPushConfig(ModifyPushConfigRequest content)
                                                       throws java.io.IOException

Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified. Create a request for the method "subscriptions.modifyPushConfig". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the ModifyPushConfigRequest

Returns:

the request

Throws:

java.io.IOException

pull

public Pubsub.Subscriptions.Pull pull(PullRequest content)
                               throws java.io.IOException

Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load). Create a request for the method "subscriptions.pull". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the PullRequest

Returns:

the request

Throws:

java.io.IOException

pullBatch

public Pubsub.Subscriptions.PullBatch pullBatch(PullBatchRequest content)
                                         throws java.io.IOException

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription. Create a request for the method "subscriptions.pullBatch". This request holds the parameters needed by the pubsub server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the PullBatchRequest

Returns:

the request

Throws:

java.io.IOException