google.pubsub.v1.subscriber_api

Accesses the google.pubsub.v1 Subscriber API.

Classes

SubscriberApi([service_path, port, channel, ...]) The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the Pull method.
class google.pubsub.v1.subscriber_api.SubscriberApi(service_path='pubsub.googleapis.com', port=443, channel=None, metadata_transformer=None, ssl_creds=None, scopes=None, client_config=None, timeout=30, app_name='gax', app_version='0.12.2')[source]

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the Pull method.

Constructor.

Parameters:
  • service_path (string) – The domain name of the API remote host.
  • port (int) – The port on which to connect to the remote host.
  • channel (grpc.beta.implementations.Channel) – A Channel object through which to make calls.
  • ssl_creds (grpc.beta.implementations.ClientCredentials) – A ClientCredentials for use with an SSL-enabled channel.
  • client_config (dict) – A dictionary for call options for each method. See google.gax.construct_settings() for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.
  • metadata_transformer (Callable[[], list]) – A function that creates the metadata for requests.
  • timeout (int) – The default timeout, in seconds, for calls made through this client
  • app_name (string) – The codename of the calling service.
  • app_version (string) – The version of the calling service.
Returns:

A SubscriberApi object.
DEFAULT_SERVICE_PORT = 443

The default port of the service.

SERVICE_ADDRESS = 'pubsub.googleapis.com'

The default address of the service.

acknowledge(subscription, ack_ids, options=None)[source]

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.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> api = SubscriberApi()
>>> subscription = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> ack_ids = []
>>> api.acknowledge(subscription, ack_ids)
Parameters:
  • subscription (string) – The subscription whose message is being acknowledged.
  • ack_ids (list[string]) – The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty.
  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
create_subscription(name, topic, push_config=None, ack_deadline_seconds=0, options=None)[source]

Creates a subscription to 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.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> api = SubscriberApi()
>>> name = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> topic = api.topic_path('[PROJECT]', '[TOPIC]')
>>> response = api.create_subscription(name, topic)
Parameters:
  • name (string) – 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".
  • topic (string) – The name of the topic from which this subscription is receiving messages. The value of this field will be _deleted-topic_ if the topic has been deleted.
  • push_config (google.pubsub.v1.pubsub_pb2.PushConfig) – If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
  • ack_deadline_seconds (int) –

    This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).

    For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using pull.

    For push delivery, this value is also used to set the request timeout for the call to the push endpoint.

    If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

    If this parameter is not set, the default value of 10 seconds is used.

  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Returns:

A google.pubsub.v1.pubsub_pb2.Subscription instance.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
delete_subscription(subscription, options=None)[source]

Deletes an existing subscription. All pending messages 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.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> api = SubscriberApi()
>>> subscription = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> api.delete_subscription(subscription)
Parameters:
  • subscription (string) – The subscription to delete.
  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
get_subscription(subscription, options=None)[source]

Gets the configuration details of a subscription.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> api = SubscriberApi()
>>> subscription = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> response = api.get_subscription(subscription)
Parameters:
  • subscription (string) – The name of the subscription to get.
  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Returns:

A google.pubsub.v1.pubsub_pb2.Subscription instance.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
list_subscriptions(project, page_size=0, options=None)[source]

Lists matching subscriptions.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> from google.gax import CallOptions, INITIAL_PAGE
>>> api = SubscriberApi()
>>> project = api.project_path('[PROJECT]')
>>>
>>> # Iterate over all results
>>> for element in api.list_subscriptions(project):
>>>   # process element
>>>   pass
>>>
>>> # Or iterate over results one page at a time
>>> for page in api.list_subscriptions(project, options=CallOptions(page_token=INITIAL_PAGE)):
>>>   for element in page:
>>>     # process element
>>>     pass
Parameters:
  • project (string) – The name of the cloud project that subscriptions belong to.
  • page_size (int) – Maximum number of subscriptions to return.
  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Returns:

A google.gax.PageIterator instance. By default, this is an iterable of google.pubsub.v1.pubsub_pb2.Subscription instances. This object can also be configured to iterate over the pages of the response through the CallOptions parameter.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
classmethod match_project_from_project_name(project_name)[source]

Parses the project from a project resource.

Parameters:project_name (string) – A fully-qualified path representing a project resource.
Returns:A string representing the project.
classmethod match_project_from_subscription_name(subscription_name)[source]

Parses the project from a subscription resource.

Parameters:subscription_name (string) – A fully-qualified path representing a subscription resource.
Returns:A string representing the project.
classmethod match_project_from_topic_name(topic_name)[source]

Parses the project from a topic resource.

Parameters:topic_name (string) – A fully-qualified path representing a topic resource.
Returns:A string representing the project.
classmethod match_subscription_from_subscription_name(subscription_name)[source]

Parses the subscription from a subscription resource.

Parameters:subscription_name (string) – A fully-qualified path representing a subscription resource.
Returns:A string representing the subscription.
classmethod match_topic_from_topic_name(topic_name)[source]

Parses the topic from a topic resource.

Parameters:topic_name (string) – A fully-qualified path representing a topic resource.
Returns:A string representing the topic.
modify_ack_deadline(subscription, ack_ids, ack_deadline_seconds, options=None)[source]

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.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> api = SubscriberApi()
>>> subscription = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> ack_ids = []
>>> ack_deadline_seconds = 0
>>> api.modify_ack_deadline(subscription, ack_ids, ack_deadline_seconds)
Parameters:
  • subscription (string) – The name of the subscription.
  • ack_ids (list[string]) – List of acknowledgment IDs.
  • ack_deadline_seconds (int) – The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request.
  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
modify_push_config(subscription, push_config, options=None)[source]

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.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> from google.pubsub.v1 import pubsub_pb2
>>> api = SubscriberApi()
>>> subscription = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> push_config = pubsub_pb2.PushConfig()
>>> api.modify_push_config(subscription, push_config)
Parameters:
  • subscription (string) – The name of the subscription.
  • push_config (google.pubsub.v1.pubsub_pb2.PushConfig) –

    The push configuration for future deliveries.

    An empty pushConfig indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if Pull is not called.

  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
classmethod project_path(project)[source]

Returns a fully-qualified project resource name string.

pull(subscription, max_messages, return_immediately=False, options=None)[source]

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return UNAVAILABLE if there are too many concurrent pull requests pending for the given subscription.

Example

>>> from google.pubsub.v1.subscriber_api import SubscriberApi
>>> api = SubscriberApi()
>>> subscription = api.subscription_path('[PROJECT]', '[SUBSCRIPTION]')
>>> max_messages = 0
>>> response = api.pull(subscription, max_messages)
Parameters:
  • subscription (string) – The subscription from which messages should be pulled.
  • return_immediately (bool) – If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.
  • max_messages (int) – The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
  • options (google.gax.CallOptions) – Overrides the default settings for this call, e.g, timeout, retries etc.
Returns:

A google.pubsub.v1.pubsub_pb2.PullResponse instance.
Raises:

google.gax.errors.GaxError if the RPC is aborted.
classmethod subscription_path(project, subscription)[source]

Returns a fully-qualified subscription resource name string.

classmethod topic_path(project, topic)[source]

Returns a fully-qualified topic resource name string.