v1

v1

Source:

Type Definitions

AcknowledgeRequest

Request for the Acknowledge method.

Properties:
Name Type Description
subscription string

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

ackIds Array.<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.

Source:
See:

CreateSnapshotRequest

Request for the CreateSnapshot method.

Properties:
Name Type Description
name string

Optional user-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is projects/{project}/snapshots/{snap}.

subscription string

The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.

labels Object.<string, string>

See Creating and managing labels.

Source:
See:

DeleteSnapshotRequest

Request for the DeleteSnapshot method.

Properties:
Name Type Description
snapshot string

The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.

Source:
See:

DeleteSubscriptionRequest

Request for the DeleteSubscription method.

Properties:
Name Type Description
subscription string

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

Source:
See:

DeleteTopicRequest

Request for the DeleteTopic method.

Properties:
Name Type Description
topic string

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

Source:
See:

ExpirationPolicy

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

Properties:
Name Type Description
ttl Object

Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

This object should have the same structure as Duration

Source:
See:

GetSnapshotRequest

Request for the GetSnapshot method.

Properties:
Name Type Description
snapshot string

The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.

Source:
See:

GetSubscriptionRequest

Request for the GetSubscription method.

Properties:
Name Type Description
subscription string

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

Source:
See:

GetTopicRequest

Request for the GetTopic method.

Properties:
Name Type Description
topic string

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

Source:
See:

ListSnapshotsRequest

Request for the ListSnapshots method.

Properties:
Name Type Description
project string

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

pageSize number

Maximum number of snapshots to return.

pageToken string

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

Source:
See:

ListSnapshotsResponse

Response for the ListSnapshots method.

Properties:
Name Type Description
snapshots Array.<Object>

The resulting snapshots.

This object should have the same structure as Snapshot

nextPageToken string

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

Source:
See:

ListSubscriptionsRequest

Request for the ListSubscriptions method.

Properties:
Name Type Description
project string

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

pageSize number

Maximum number of subscriptions to return.

pageToken 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.

Source:
See:

ListSubscriptionsResponse

Response for the ListSubscriptions method.

Properties:
Name Type Description
subscriptions Array.<Object>

The subscriptions that match the request.

This object should have the same structure as Subscription

nextPageToken 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.

Source:
See:

ListTopicSnapshotsRequest

Request for the ListTopicSnapshots method.

Properties:
Name Type Description
topic string

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

pageSize number

Maximum number of snapshot names to return.

pageToken string

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

Source:
See:

ListTopicSnapshotsResponse

Response for the ListTopicSnapshots method.

Properties:
Name Type Description
snapshots Array.<string>

The names of the snapshots that match the request.

nextPageToken string

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

Source:
See:

ListTopicsRequest

Request for the ListTopics method.

Properties:
Name Type Description
project string

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

pageSize number

Maximum number of topics to return.

pageToken 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.

Source:
See:

ListTopicsResponse

Response for the ListTopics method.

Properties:
Name Type Description
topics Array.<Object>

The resulting topics.

This object should have the same structure as Topic

nextPageToken string

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

Source:
See:

ListTopicSubscriptionsRequest

Request for the ListTopicSubscriptions method.

Properties:
Name Type Description
topic string

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

pageSize number

Maximum number of subscription names to return.

pageToken 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.

Source:
See:

ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

Properties:
Name Type Description
subscriptions Array.<string>

The names of the subscriptions that match the request.

nextPageToken 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.

Source:
See:

MessageStoragePolicy

Properties:
Name Type Description
allowedPersistenceRegions Array.<string>

A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage. Messages published by publishers running in non-allowed GCP regions (or running outside of GCP altogether) will be routed for storage in one of the allowed regions. An empty list means that no regions are allowed, and is not a valid configuration.

Source:
See:

ModifyAckDeadlineRequest

Request for the ModifyAckDeadline method.

Properties:
Name Type Description
subscription string

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

ackIds Array.<string>

List of acknowledgment IDs.

ackDeadlineSeconds number

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 might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

Source:
See:

ModifyPushConfigRequest

Request for the ModifyPushConfig method.

Properties:
Name Type Description
subscription string

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

pushConfig Object

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.

This object should have the same structure as PushConfig

Source:
See:

OidcToken

Contains information needed for generating an OpenID Connect token.

Properties:
Name Type Description
serviceAccountEmail string

Service account email to be used for generating the OIDC token. The caller (for CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account.

audience string

Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used.

Source:
See:

PublishRequest

Request for the Publish method.

Properties:
Name Type Description
topic string

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

messages Array.<Object>

The messages to publish.

This object should have the same structure as PubsubMessage

Source:
See:

PublishResponse

Response for the Publish method.

Properties:
Name Type Description
messageIds Array.<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.

Source:
See:

PubsubMessage

A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See Quotas and limits for more information about message limits.

Properties:
Name Type Description
data Buffer

The message data field. If this field is empty, the message must contain at least one attribute.

attributes Object.<string, string>

Optional attributes for this message.

messageId 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.

publishTime Object

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.

This object should have the same structure as Timestamp

orderingKey string

Identifies related messages for which publish order should be respected. If a Subscription has enable_message_ordering set to true, messages published with the same ordering_key value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Source:
See:

PullRequest

Request for the Pull method.

Properties:
Name Type Description
subscription string

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

returnImmediately boolean

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.

maxMessages number

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

Source:
See:

PullResponse

Response for the Pull method.

Properties:
Name Type Description
receivedMessages Array.<Object>

Received Pub/Sub messages. The list will be empty if there are no more messages available in the backlog. For JSON, the response can be entirely empty. The Pub/Sub system may return fewer than the maxMessages requested even if there are more messages available in the backlog.

This object should have the same structure as ReceivedMessage

Source:
See:

PushConfig

Configuration for a push delivery endpoint.

Properties:
Name Type Description
pushEndpoint string

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

attributes Object.<string, string>

Endpoint configuration attributes that can be used to control different aspects of the message delivery.

The only 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).

If not present during the CreateSubscription call, it will default to the version of the Pub/Sub API used to make such call. If not present in 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 only supported values for the x-goog-version 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.

For example:

attributes { "x-goog-version": "v1" } 
oidcToken Object

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

This object should have the same structure as OidcToken

Source:
See:

ReceivedMessage

A message and its corresponding acknowledgment ID.

Properties:
Name Type Description
ackId string

This ID can be used to acknowledge the received message.

message Object

The message.

This object should have the same structure as PubsubMessage

Source:
See:

SeekRequest

Request for the Seek method.

Properties:
Name Type Description
subscription string

The subscription to affect.

time Object

The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of message_retention_duration and retain_acked_messages). For example, if time corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored.

This object should have the same structure as Timestamp

snapshot string

The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is projects/{project}/snapshots/{snap}.

Source:
See:

SeekResponse

Response for the Seek method (this response is empty).

Source:
See:

Snapshot

A snapshot resource. Snapshots are used in Seek 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.

Properties:
Name Type Description
name string

The name of the snapshot.

topic string

The name of the topic from which this snapshot is retaining messages.

expireTime Object

The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is 7 days - (age of oldest unacked message in the subscription). For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation.

This object should have the same structure as Timestamp

labels Object.<string, string>

See Creating and managing labels.

Source:
See:

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.

Properties:
Name Type Description
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}.

ackIds Array.<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.

modifyDeadlineSeconds Array.<number>

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.

modifyDeadlineAckIds Array.<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.

streamAckDeadlineSeconds number

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).

Source:
See:

StreamingPullResponse

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

Properties:
Name Type Description
receivedMessages Array.<Object>

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

This object should have the same structure as ReceivedMessage

Source:
See:

Subscription

A subscription resource.

Properties:
Name Type Description
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. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

pushConfig Object

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.

This object should have the same structure as PushConfig

ackDeadlineSeconds number

The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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.

retainAckedMessages boolean

Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the message_retention_duration window. This must be true if you would like to Seek to a timestamp.

messageRetentionDuration Object

How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

This object should have the same structure as Duration

labels Object.<string, string>

See Creating and managing labels.

enableMessageOrdering boolean

If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

expirationPolicy Object

A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day.

This object should have the same structure as ExpirationPolicy

Source:
See:

Topic

A topic resource.

Properties:
Name Type Description
name string

The name of the topic. It must have the format "projects/{project}/topics/{topic}". {topic} 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".

labels Object.<string, string>

See Creating and managing labels.

messageStoragePolicy Object

Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.

This object should have the same structure as MessageStoragePolicy

kmsKeyName string

The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.

The expected format is projects/* /locations/* /keyRings/* /cryptoKeys/*.

Source:
See:

UpdateSnapshotRequest

Request for the UpdateSnapshot method.

Properties:
Name Type Description
snapshot Object

The updated snapshot object.

This object should have the same structure as Snapshot

updateMask Object

Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

This object should have the same structure as FieldMask

Source:
See:

UpdateSubscriptionRequest

Request for the UpdateSubscription method.

Properties:
Name Type Description
subscription Object

The updated subscription object.

This object should have the same structure as Subscription

updateMask Object

Indicates which fields in the provided subscription to update. Must be specified and non-empty.

This object should have the same structure as FieldMask

Source:
See:

UpdateTopicRequest

Request for the UpdateTopic method.

Properties:
Name Type Description
topic Object

The updated topic object.

This object should have the same structure as Topic

updateMask Object

Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if update_mask contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The message_storage_policy must not be set in the topic provided above.

This object should have the same structure as FieldMask

Source:
See: