com.google.api.services.pubsub

Class Pubsub.Projects.Subscriptions

java.lang.Object

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

Enclosing class:

Pubsub.Projects

public class Pubsub.Projects.Subscriptions
extends Object

The "subscriptions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Pubsub.Projects.Subscriptions.Acknowledge
class	Pubsub.Projects.Subscriptions.Create
class	Pubsub.Projects.Subscriptions.Delete
class	Pubsub.Projects.Subscriptions.Detach
class	Pubsub.Projects.Subscriptions.Get
class	Pubsub.Projects.Subscriptions.GetIamPolicy
class	Pubsub.Projects.Subscriptions.List
class	Pubsub.Projects.Subscriptions.ModifyAckDeadline
class	Pubsub.Projects.Subscriptions.ModifyPushConfig
class	Pubsub.Projects.Subscriptions.Patch
class	Pubsub.Projects.Subscriptions.Pull
class	Pubsub.Projects.Subscriptions.Seek
class	Pubsub.Projects.Subscriptions.SetIamPolicy
class	Pubsub.Projects.Subscriptions.TestIamPermissions

Constructor Summary

Constructors

Constructor and Description
Subscriptions()

Method Summary

Modifier and Type	Method and Description
Pubsub.Projects.Subscriptions.Acknowledge	acknowledge(String subscription, AcknowledgeRequest content) Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`.
Pubsub.Projects.Subscriptions.Create	create(String name, Subscription content) Creates a subscription to a given topic.
Pubsub.Projects.Subscriptions.Delete	delete(String subscription) Deletes an existing subscription.
Pubsub.Projects.Subscriptions.Detach	detach(String subscription) Detaches a subscription from this topic.
Pubsub.Projects.Subscriptions.Get	get(String subscription) Gets the configuration details of a subscription.
Pubsub.Projects.Subscriptions.GetIamPolicy	getIamPolicy(String resource) Gets the access control policy for a resource.
Pubsub.Projects.Subscriptions.List	list(String project) Lists matching subscriptions.
Pubsub.Projects.Subscriptions.ModifyAckDeadline	modifyAckDeadline(String subscription, ModifyAckDeadlineRequest content) Modifies the ack deadline for a specific message.
Pubsub.Projects.Subscriptions.ModifyPushConfig	modifyPushConfig(String subscription, ModifyPushConfigRequest content) Modifies the `PushConfig` for a specified subscription.
Pubsub.Projects.Subscriptions.Patch	patch(String name, UpdateSubscriptionRequest content) Updates an existing subscription.
Pubsub.Projects.Subscriptions.Pull	pull(String subscription, PullRequest content) Pulls messages from the server.
Pubsub.Projects.Subscriptions.Seek	seek(String subscription, SeekRequest content) Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
Pubsub.Projects.Subscriptions.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
Pubsub.Projects.Subscriptions.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.

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.Projects.Subscriptions.Acknowledge acknowledge(String subscription,
                                                             AcknowledgeRequest content)
                                                      throws IOException

Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error. 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:

subscription - Required. The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`.

content - the AcknowledgeRequest

Returns:

the request

Throws:

IOException

create

public Pubsub.Projects.Subscriptions.Create create(String name,
                                                   Subscription content)
                                            throws IOException

Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. 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:

name - Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.

content - the Subscription

Returns:

the request

Throws:

IOException

delete

public Pubsub.Projects.Subscriptions.Delete delete(String subscription)
                                            throws IOException

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified. 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 - Required. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`.

Returns:

the request

Throws:

IOException

detach

public Pubsub.Projects.Subscriptions.Detach detach(String subscription)
                                            throws IOException

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop. Create a request for the method "subscriptions.detach". 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 - Required. The subscription to detach. Format is `projects/{project}/subscriptions/{subscription}`.

Returns:

the request

Throws:

IOException

get

public Pubsub.Projects.Subscriptions.Get get(String subscription)
                                      throws 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 - Required. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`.

Returns:

the request

Throws:

IOException

getIamPolicy

public Pubsub.Projects.Subscriptions.GetIamPolicy getIamPolicy(String resource)
                                                        throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "subscriptions.getIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

Returns:

the request

Throws:

IOException

list

public Pubsub.Projects.Subscriptions.List list(String project)
                                        throws 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.

Parameters:

project - Required. The name of the project in which to list subscriptions. Format is `projects/{project-id}`.

Returns:

the request

Throws:

IOException

modifyAckDeadline

public Pubsub.Projects.Subscriptions.ModifyAckDeadline modifyAckDeadline(String subscription,
                                                                         ModifyAckDeadlineRequest content)
                                                                  throws IOException

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription- level `ackDeadlineSeconds` used for subsequent messages. 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:

subscription - Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.

content - the ModifyAckDeadlineRequest

Returns:

the request

Throws:

IOException

modifyPushConfig

public Pubsub.Projects.Subscriptions.ModifyPushConfig modifyPushConfig(String subscription,
                                                                       ModifyPushConfigRequest content)
                                                                throws IOException

Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`. 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:

subscription - Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`.

content - the ModifyPushConfigRequest

Returns:

the request

Throws:

IOException

patch

public Pubsub.Projects.Subscriptions.Patch patch(String name,
                                                 UpdateSubscriptionRequest content)
                                          throws IOException

Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. Create a request for the method "subscriptions.patch". 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:

name - Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.

content - the UpdateSubscriptionRequest

Returns:

the request

Throws:

IOException

pull

public Pubsub.Projects.Subscriptions.Pull pull(String subscription,
                                               PullRequest content)
                                        throws IOException

Pulls messages from the server. 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:

subscription - Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`.

content - the PullRequest

Returns:

the request

Throws:

IOException

seek

public Pubsub.Projects.Subscriptions.Seek seek(String subscription,
                                               SeekRequest content)
                                        throws IOException

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay- overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic. Create a request for the method "subscriptions.seek". 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 - Required. The subscription to affect.

content - the SeekRequest

Returns:

the request

Throws:

IOException

setIamPolicy

public Pubsub.Projects.Subscriptions.SetIamPolicy setIamPolicy(String resource,
                                                               SetIamPolicyRequest content)
                                                        throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "subscriptions.setIamPolicy". 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:

resource - REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public Pubsub.Projects.Subscriptions.TestIamPermissions testIamPermissions(String resource,
                                                                           TestIamPermissionsRequest content)
                                                                    throws IOException

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Create a request for the method "subscriptions.testIamPermissions". 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:

resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException