Package google.pubsub.v1

Index

Publisher

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

CreateTopic

rpc CreateTopic(Topic) returns (Topic)

Creates the given topic with the given name.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

DeleteTopic

rpc DeleteTopic(DeleteTopicRequest) returns (Empty)

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, but their topic field is set to _deleted-topic_.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

GetTopic

rpc GetTopic(GetTopicRequest) returns (Topic)

Gets the configuration of a topic.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ListTopicSubscriptions

rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest) returns (ListTopicSubscriptionsResponse)

Lists the name of the subscriptions for this topic.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ListTopics

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse)

Lists matching topics.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Publish

rpc Publish(PublishRequest) returns (PublishResponse)

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Subscriber

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the Pull method or by establishing a bi-directional stream using the StreamingPull method.

Acknowledge

rpc Acknowledge(AcknowledgeRequest) returns (Empty)

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.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

CreateSubscription

rpc CreateSubscription(Subscription) returns (Subscription)

Creates a subscription to a given topic. 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. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

DeleteSubscription

rpc DeleteSubscription(DeleteSubscriptionRequest) returns (Empty)

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.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

GetSubscription

rpc GetSubscription(GetSubscriptionRequest) returns (Subscription)

Gets the configuration details of a subscription.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ListSubscriptions

rpc ListSubscriptions(ListSubscriptionsRequest) returns (ListSubscriptionsResponse)

Lists matching subscriptions.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ModifyAckDeadline

rpc ModifyAckDeadline(ModifyAckDeadlineRequest) returns (Empty)

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.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

ModifyPushConfig

rpc ModifyPushConfig(ModifyPushConfigRequest) returns (Empty)

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.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

Pull

rpc Pull(PullRequest) returns (PullResponse)

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.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

StreamingPull

rpc StreamingPull(StreamingPullRequest) returns (StreamingPullResponse)

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status OK to reassign server-side resources, in which case, the client should re-establish the stream. UNAVAILABLE may also be returned in the case of a transient error (e.g., a server restart). These should also be retried by the client. Flow control can be achieved by configuring the underlying RPC channel.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/pubsub
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Auth Guide.

AcknowledgeRequest

Request for the Acknowledge method.

Fields
subscription

string

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

ack_ids[]

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.

DeleteSubscriptionRequest

Request for the DeleteSubscription method.

Fields
subscription

string

The subscription to delete. Format is projects/{project}/subscriptions/{sub}.

DeleteTopicRequest

Request for the DeleteTopic method.

Fields
topic

string

Name of the topic to delete. Format is projects/{project}/topics/{topic}.

GetSubscriptionRequest

Request for the GetSubscription method.

Fields
subscription

string

The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.

GetTopicRequest

Request for the GetTopic method.

Fields
topic

string

The name of the topic to get. Format is projects/{project}/topics/{topic}.

ListSubscriptionsRequest

Request for the ListSubscriptions method.

Fields
project

string

The name of the cloud project that subscriptions belong to. Format is projects/{project}.

page_size

int32

Maximum number of subscriptions to return.

page_token

string

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.

ListSubscriptionsResponse

Response for the ListSubscriptions method.

Fields
subscriptions[]

Subscription

The subscriptions that match the request.

next_page_token

string

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.

ListTopicSubscriptionsRequest

Request for the ListTopicSubscriptions method.

Fields
topic

string

The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.

page_size

int32

Maximum number of subscription names to return.

page_token

string

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.

ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

Fields
subscriptions[]

string

The names of the subscriptions that match the request.

next_page_token

string

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.

ListTopicsRequest

Request for the ListTopics method.

Fields
project

string

The name of the cloud project that topics belong to. Format is projects/{project}.

page_size

int32

Maximum number of topics to return.

page_token

string

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.

ListTopicsResponse

Response for the ListTopics method.

Fields
topics[]

Topic

The resulting topics.

next_page_token

string

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

ModifyAckDeadlineRequest

Request for the ModifyAckDeadline method.

Fields
subscription

string

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

ack_ids[]

string

List of acknowledgment IDs.

ack_deadline_seconds

int32

The new ack deadline with respect to the time this request was sent to the Pub/Sub system. 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. The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

ModifyPushConfigRequest

Request for the ModifyPushConfig method.

Fields
subscription

string

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

push_config

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 or StreamingPull is not called.

PublishRequest

Request for the Publish method.

Fields
topic

string

The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.

messages[]

PubsubMessage

The messages to publish.

PublishResponse

Response for the Publish method.

Fields
message_ids[]

string

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.

PubsubMessage

A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

Fields
data

bytes

The message payload.

attributes

map<string, string>

Optional attributes for this message.

message_id

string

ID of this message, assigned by the server when the message is published. 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 the publisher in a Publish call.

publish_time

Timestamp

The time at which the message was published, populated by the server when it receives the Publish call. It must not be populated by the publisher in a Publish call.

PullRequest

Request for the Pull method.

Fields
subscription

string

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

return_immediately

bool

If this field set to true, the system will respond immediately even if it there are no messages available to return in the Pull response. Otherwise, the system may wait (for a bounded amount of time) 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

int32

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

PullResponse

Response for the Pull method.

Fields
received_messages[]

ReceivedMessage

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.

PushConfig

Configuration for a push delivery endpoint.

Fields
push_endpoint

string

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

attributes

map<string, string>

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 pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (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.
  • v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API.

ReceivedMessage

A message and its corresponding acknowledgment ID.

Fields
ack_id

string

This ID can be used to acknowledge the received message.

message

PubsubMessage

The message.

StreamingPullRequest

Request for the StreamingPull streaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server.

Fields
subscription

string

The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server. Format is projects/{project}/subscriptions/{sub}.

ack_ids[]

string

List of acknowledgement IDs for acknowledging previously received messages (received on this stream or a different stream). If an ack ID has expired, the corresponding message may be redelivered later. Acknowledging a message more than once will not result in an error. If the acknowledgement ID is malformed, the stream will be aborted with status INVALID_ARGUMENT.

modify_deadline_seconds[]

int32

The list of new ack deadlines for the IDs listed in modify_deadline_ack_ids. The size of this list must be the same as the size of modify_deadline_ack_ids. If it differs the stream will be aborted with INVALID_ARGUMENT. Each element in this list is applied to the element in the same position in modify_deadline_ack_ids. The new ack deadline is 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 this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with status INVALID_ARGUMENT.

modify_deadline_ack_ids[]

string

List of acknowledgement IDs whose deadline will be modified based on the corresponding element in modify_deadline_seconds. This field can be used 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.

stream_ack_deadline_seconds

int32

The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

StreamingPullResponse

Response for the StreamingPull method. This response is used to stream messages from the server to the client.

Fields
received_messages[]

ReceivedMessage

Received Pub/Sub messages. This will not be empty.

Subscription

A subscription resource.

Fields
name

string

Name of the subscription. Format is projects/{project}/subscriptions/{sub}.

topic

string

The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

push_config

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

int32

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 non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

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.

Topic

A topic resource.

Fields
name

string

Name of the topic. Format is projects/{project}/topics/{topic}.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Cloud Pub/Sub