package google.pubsub.v1beta2

Get desktop application:
View/edit binary Protocol Buffers messages

The service that an application uses to manipulate topics, and to send messages to a topic.

• rpc CreateTopic (Topic, Topic)

  pubsub.proto:88

  Creates the given topic with the given name.

• rpc Publish (PublishRequest, PublishResponse)

  pubsub.proto:92

  Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

  message PublishRequest

  pubsub.proto:141

  Request for the Publish method.

  • string topic = 1

    The messages in the request will be published on this topic.

  • repeated PubsubMessage messages = 2

    The messages to publish.

  message PublishResponse

  pubsub.proto:150

  Response for the Publish method.

  • repeated string message_ids = 1

    The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.

• rpc GetTopic (GetTopicRequest, Topic)

  pubsub.proto:95

  Gets the configuration of a topic.

  message GetTopicRequest

  pubsub.proto:135

  Request for the GetTopic method.

  • string topic = 1

    The name of the topic to get.

• rpc ListTopics (ListTopicsRequest, ListTopicsResponse)

  pubsub.proto:98

  Lists matching topics.

  message ListTopicsRequest

  pubsub.proto:158

  Request for the ListTopics method.

  • string project = 1

    The name of the cloud project that topics belong to.

  • int32 page_size = 2

    Maximum number of topics to return.

  • string page_token = 3

    The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.

  message ListTopicsResponse

  pubsub.proto:172

  Response for the ListTopics method.

  • repeated Topic topics = 1

    The resulting topics.

  • string next_page_token = 2

    If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.

• rpc ListTopicSubscriptions (ListTopicSubscriptionsRequest, ListTopicSubscriptionsResponse)

  pubsub.proto:101

  Lists the name of the subscriptions for this topic.

  message ListTopicSubscriptionsRequest

  pubsub.proto:182

  Request for the ListTopicSubscriptions method.

  • string topic = 1

    The name of the topic that subscriptions are attached to.

  • int32 page_size = 2

    Maximum number of subscription names to return.

  • string page_token = 3

    The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.

  message ListTopicSubscriptionsResponse

  pubsub.proto:196

  Response for the ListTopicSubscriptions method.

  • repeated string subscriptions = 1

    The names of the subscriptions that match the request.

  • string next_page_token = 2

    If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListTopicSubscriptionsRequest to get more subscriptions.

• rpc DeleteTopic (DeleteTopicRequest, protobuf.Empty)

  pubsub.proto:109

  Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted.

  message DeleteTopicRequest

  pubsub.proto:207

  Request for the DeleteTopic method.

  • string topic = 1

    Name of the topic to delete.

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

• rpc CreateSubscription (Subscription, Subscription)

  pubsub.proto:35

  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.

• rpc GetSubscription (GetSubscriptionRequest, Subscription)

  pubsub.proto:38

  Gets the configuration details of a subscription.

  message GetSubscriptionRequest

  pubsub.proto:287

  Request for the GetSubscription method.

  • string subscription = 1

    The name of the subscription to get.

• rpc ListSubscriptions (ListSubscriptionsRequest, ListSubscriptionsResponse)

  pubsub.proto:41

  Lists matching subscriptions.

  message ListSubscriptionsRequest

  pubsub.proto:293

  Request for the ListSubscriptions method.

  • string project = 1

    The name of the cloud project that subscriptions belong to.

  • int32 page_size = 2

    Maximum number of subscriptions to return.

  • string page_token = 3

    The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data.

  message ListSubscriptionsResponse

  pubsub.proto:307

  Response for the ListSubscriptions method.

  • repeated Subscription subscriptions = 1

    The subscriptions that match the request.

  • string next_page_token = 2

    If not empty, indicates that there may be more subscriptions that match the request; this value should be passed in a new ListSubscriptionsRequest to get more subscriptions.

• rpc DeleteSubscription (DeleteSubscriptionRequest, protobuf.Empty)

  pubsub.proto:49

  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.

  message DeleteSubscriptionRequest

  pubsub.proto:318

  Request for the DeleteSubscription method.

  • string subscription = 1

    The subscription to delete.

• rpc ModifyAckDeadline (ModifyAckDeadlineRequest, protobuf.Empty)

  pubsub.proto:56

  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.

  message ModifyAckDeadlineRequest

  pubsub.proto:364

  Request for the ModifyAckDeadline method.

  • string subscription = 1

    The name of the subscription.

  • string ack_id = 2

    The acknowledgment ID.

  • int32 ack_deadline_seconds = 3

    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.

• rpc Acknowledge (AcknowledgeRequest, protobuf.Empty)

  pubsub.proto:66

  Acknowledges the messages associated with the ack tokens 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.

  message AcknowledgeRequest

  pubsub.proto:380

  Request for the Acknowledge method.

  • string subscription = 1

    The subscription whose message is being acknowledged.

  • repeated string ack_ids = 2

    The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the Pull response. Must not be empty.

• rpc Pull (PullRequest, PullResponse)

  pubsub.proto:72

  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.

  message PullRequest

  pubsub.proto:338

  Request for the Pull method.

  • string subscription = 1

    The subscription from which messages should be pulled.

  • bool return_immediately = 2

    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.

  • int32 max_messages = 3

    The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.

  message PullResponse

  pubsub.proto:355

  Response for the Pull method.

  • repeated ReceivedMessage received_messages = 1

    Received Pub/Sub messages. The Pub/Sub system will return zero messages if there are no more available in the backlog. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog.

• rpc ModifyPushConfig (ModifyPushConfigRequest, protobuf.Empty)

  pubsub.proto:81

  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.

  message ModifyPushConfigRequest

  pubsub.proto:324

  Request for the ModifyPushConfig method.

  • string subscription = 1

    The name of the subscription.

  • optional PushConfig push_config = 2

    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.

A message data and its attributes.

Used in: PublishRequest, ReceivedMessage

• bytes data = 1

  The message payload. For JSON requests, the value of this field must be base64-encoded.

• map<string, string> attributes = 2

  Optional attributes for this message.

• string message_id = 3

  ID of this message assigned by the server at publication time. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a PubsubMessage via a Pull call or a push delivery. It must not be populated by a publisher in a Publish call.

Configuration for a push delivery endpoint.

Used in: ModifyPushConfigRequest, Subscription

• string push_endpoint = 1

  A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".

• map<string, string> attributes = 2

  Endpoint configuration attributes. Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery. The currently supported attribute is `x-goog-version`, which you can use to change the format of the push message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the envelope (i.e. its fields and metadata). The endpoint version is based on the version of the Pub/Sub API. If not present during the CreateSubscription call, it will default to the version of the API used to make such call. If not present during a ModifyPushConfig call, its value will not be changed. GetSubscription calls will always return a valid version, even if the subscription was created without this attribute. The possible values for this attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1beta2`: uses the push format defined in the v1beta2 Pub/Sub API.

A message and its corresponding acknowledgment ID.

Used in: PullResponse

• string ack_id = 1

  This ID can be used to acknowledge the received message.

• optional PubsubMessage message = 2

  The message.

A subscription resource.

Used as request type in: Subscriber.CreateSubscription

Used as response type in: Subscriber.CreateSubscription, Subscriber.GetSubscription

Used as field type in: ListSubscriptionsResponse

• string name = 1

  Name of the subscription.

• string topic = 2

  The name of the topic from which this subscription is receiving messages. This will be present if and only if the subscription has not been detached from its topic.

• optional PushConfig push_config = 4

  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.

• int32 ack_deadline_seconds = 5

  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 delivery this value is used as the initial value for the ack deadline. It may be overridden for a specific message by calling ModifyAckDeadline. 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.

A topic resource.

Used as request type in: Publisher.CreateTopic

Used as response type in: Publisher.CreateTopic, Publisher.GetTopic

Used as field type in: ListTopicsResponse

• string name = 1

  Name of the topic.