option (google.api.default_host) = "pubsub.googleapis.com";

option (google.api.oauth_scopes) =

"https://www.googleapis.com/auth/cloud-platform,"

"https://www.googleapis.com/auth/pubsub";

// Creates the given topic with the given name. See the [resource name rules]

// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).

rpc CreateTopic(Topic) returns (Topic) {

option (google.api.http) = {

put: "/v1/{name=projects/*/topics/*}"

body: "*"

};

option (google.api.method_signature) = "name";

}

// Updates an existing topic by updating the fields specified in the update

// mask. Note that certain properties of a topic are not modifiable.

rpc UpdateTopic(UpdateTopicRequest) returns (Topic) {

option (google.api.http) = {

patch: "/v1/{topic.name=projects/*/topics/*}"

body: "*"

};

option (google.api.method_signature) = "topic,update_mask";

}

// Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic

// does not exist.

rpc Publish(PublishRequest) returns (PublishResponse) {

option (google.api.http) = {

post: "/v1/{topic=projects/*/topics/*}:publish"

body: "*"

};

option (google.api.method_signature) = "topic,messages";

}

// Gets the configuration of a topic.

rpc GetTopic(GetTopicRequest) returns (Topic) {

option (google.api.http) = {

get: "/v1/{topic=projects/*/topics/*}"

};

option (google.api.method_signature) = "topic";

}

// Lists matching topics.

rpc ListTopics(ListTopicsRequest) returns (ListTopicsResponse) {

option (google.api.http) = {

get: "/v1/{project=projects/*}/topics"

};

option (google.api.method_signature) = "project";

}

// Lists the names of the attached subscriptions on this topic.

rpc ListTopicSubscriptions(ListTopicSubscriptionsRequest)

returns (ListTopicSubscriptionsResponse) {

option (google.api.http) = {

get: "/v1/{topic=projects/*/topics/*}/subscriptions"

};

option (google.api.method_signature) = "topic";

}

// Lists the names of the snapshots on this topic. 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.

rpc ListTopicSnapshots(ListTopicSnapshotsRequest)

returns (ListTopicSnapshotsResponse) {

option (google.api.http) = {

get: "/v1/{topic=projects/*/topics/*}/snapshots"

};

option (google.api.method_signature) = "topic";

}

// 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_`.

rpc DeleteTopic(DeleteTopicRequest) returns (google.protobuf.Empty) {

option (google.api.http) = {

delete: "/v1/{topic=projects/*/topics/*}"

};

option (google.api.method_signature) = "topic";

}

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

rpc DetachSubscription(DetachSubscriptionRequest)

returns (DetachSubscriptionResponse) {

option (google.api.http) = {

post: "/v1/{subscription=projects/*/subscriptions/*}:detach"

};

}

// Optional. A list of IDs of Google Cloud regions where messages that are

// published to the topic may be persisted in storage. Messages published by

// publishers running in non-allowed Google Cloud regions (or running outside

// of Google Cloud altogether) are routed for storage in one of the allowed

// regions. An empty list means that no regions are allowed, and is not a

// valid configuration.

repeated string allowed_persistence_regions = 1

[(google.api.field_behavior) = OPTIONAL];

// Optional. If true, `allowed_persistence_regions` is also used to enforce

// in-transit guarantees for messages. That is, Pub/Sub will fail

// Publish operations on this topic and subscribe operations

// on any subscription attached to this topic in any region that is

// not in `allowed_persistence_regions`.

bool enforce_in_transit = 2 [(google.api.field_behavior) = OPTIONAL];

// Required. The name of the schema that messages published should be

// validated against. Format is `projects/{project}/schemas/{schema}`. The

// value of this field will be `_deleted-schema_` if the schema has been

// deleted.

string schema = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }

];

// Optional. The encoding of messages validated against `schema`.

Encoding encoding = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. The minimum (inclusive) revision allowed for validating messages.

// If empty or not present, allow any revision to be validated against

// last_revision or any revision created before.

string first_revision_id = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. The maximum (inclusive) revision allowed for validating messages.

// If empty or not present, allow any revision to be validated against

// first_revision or any revision created after.

string last_revision_id = 4 [(google.api.field_behavior) = OPTIONAL];

// Ingestion settings for Amazon Kinesis Data Streams.

message AwsKinesis {

// Possible states for ingestion from Amazon Kinesis Data Streams.

enum State {

// Default value. This value is unused.

STATE_UNSPECIFIED = 0;

// Ingestion is active.

ACTIVE = 1;

// Permission denied encountered while consuming data from Kinesis.

// This can happen if:

// - The provided `aws_role_arn` does not exist or does not have the

// appropriate permissions attached.

// - The provided `aws_role_arn` is not set up properly for Identity

// Federation using `gcp_service_account`.

// - The Pub/Sub SA is not granted the

// `iam.serviceAccounts.getOpenIdToken` permission on

// `gcp_service_account`.

KINESIS_PERMISSION_DENIED = 2;

// Permission denied encountered while publishing to the topic. This can

// happen due to Pub/Sub SA has not been granted the [appropriate publish

// permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)

PUBLISH_PERMISSION_DENIED = 3;

// The Kinesis stream does not exist.

STREAM_NOT_FOUND = 4;

// The Kinesis consumer does not exist.

CONSUMER_NOT_FOUND = 5;

}

// Output only. An output-only field that indicates the state of the Kinesis

// ingestion source.

State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Required. The Kinesis stream ARN to ingest data from.

string stream_arn = 2 [(google.api.field_behavior) = REQUIRED];

// Required. The Kinesis consumer ARN to used for ingestion in Enhanced

// Fan-Out mode. The consumer must be already created and ready to be used.

string consumer_arn = 3 [(google.api.field_behavior) = REQUIRED];

// Required. AWS role ARN to be used for Federated Identity authentication

// with Kinesis. Check the Pub/Sub docs for how to set up this role and the

// required permissions that need to be attached to it.

string aws_role_arn = 4 [(google.api.field_behavior) = REQUIRED];

// Required. The GCP service account to be used for Federated Identity

// authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for

// the provided role). The `aws_role_arn` must be set up with

// `accounts.google.com:sub` equals to this service account number.

string gcp_service_account = 5 [(google.api.field_behavior) = REQUIRED];

}

// Only one source type can have settings set.

oneof source {

// Optional. Amazon Kinesis Data Streams.

AwsKinesis aws_kinesis = 1 [(google.api.field_behavior) = OPTIONAL];

}

option (google.api.resource) = {

type: "pubsub.googleapis.com/Topic"

pattern: "projects/{project}/topics/{topic}"

pattern: "_deleted-topic_"

};

// The state of the topic.

enum State {

// Default value. This value is unused.

STATE_UNSPECIFIED = 0;

// The topic does not have any persistent errors.

ACTIVE = 1;

// Ingestion from the data source has encountered a permanent error.

// See the more detailed error state in the corresponding ingestion

// source configuration.

INGESTION_RESOURCE_ERROR = 2;

}

// Required. 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"`.

string name = 1 [(google.api.field_behavior) = REQUIRED];

// Optional. See [Creating and managing labels]

// (https://cloud.google.com/pubsub/docs/labels).

map<string, string> labels = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

MessageStoragePolicy message_storage_policy = 3

[(google.api.field_behavior) = OPTIONAL];

// Optional. 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/*`.

string kms_key_name = 5 [(google.api.field_behavior) = OPTIONAL];

// Optional. Settings for validating messages published against a schema.

SchemaSettings schema_settings = 6 [(google.api.field_behavior) = OPTIONAL];

// Optional. Reserved for future use. This field is set only in responses from

// the server; it is ignored if it is set in any requests.

bool satisfies_pzs = 7 [(google.api.field_behavior) = OPTIONAL];

// Optional. Indicates the minimum duration to retain a message after it is

// published to the topic. If this field is set, messages published to the

// topic in the last `message_retention_duration` are always available to

// subscribers. For instance, it allows any attached subscription to [seek to

// a

// timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)

// that is up to `message_retention_duration` in the past. If this field is

// not set, message retention is controlled by settings on individual

// subscriptions. Cannot be more than 31 days or less than 10 minutes.

google.protobuf.Duration message_retention_duration = 8

[(google.api.field_behavior) = OPTIONAL];

// Output only. An output-only field indicating the state of the topic.

State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY];

// Optional. Settings for ingestion from a data source into this topic.

IngestionDataSourceSettings ingestion_data_source_settings = 10

[(google.api.field_behavior) = OPTIONAL];

// Optional. The message data field. If this field is empty, the message must

// contain at least one attribute.

bytes data = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. Attributes for this message. If this field is empty, the message

// must contain non-empty data. This can be used to filter messages on the

// subscription.

map<string, string> attributes = 2 [(google.api.field_behavior) = OPTIONAL];

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

string message_id = 3;

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

google.protobuf.Timestamp publish_time = 4;

// Optional. If non-empty, 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 non-empty `ordering_key` value

// will be delivered to subscribers in the order in which they are received by

// the Pub/Sub system. All `PubsubMessage`s published in a given

// `PublishRequest` must specify the same `ordering_key` value. For more

// information, see [ordering

// messages](https://cloud.google.com/pubsub/docs/ordering).

string ordering_key = 5 [(google.api.field_behavior) = OPTIONAL];

// Required. The name of the topic to get.

// Format is `projects/{project}/topics/{topic}`.

string topic = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }

];

// Required. The updated topic object.

Topic topic = 1 [(google.api.field_behavior) = REQUIRED];

// Required. Indicates which fields in the provided topic to update. Must be

// specified and non-empty. Note that if `update_mask` contains

// "message_storage_policy" but the `message_storage_policy` is not set in

// the `topic` provided above, then the updated value is determined by the

// policy configured at the project or organization level.

google.protobuf.FieldMask update_mask = 2

[(google.api.field_behavior) = REQUIRED];

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

// Format is `projects/{project}/topics/{topic}`.

string topic = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }

];

// Required. The messages to publish.

repeated PubsubMessage messages = 2 [(google.api.field_behavior) = REQUIRED];

// Optional. 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.

repeated string message_ids = 1 [(google.api.field_behavior) = OPTIONAL];

// Required. The name of the project in which to list topics.

// Format is `projects/{project-id}`.

string project = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = {

type: "cloudresourcemanager.googleapis.com/Project"

}

];

// Optional. Maximum number of topics to return.

int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

string page_token = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. The resulting topics.

repeated Topic topics = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. If not empty, indicates that there may be more topics that match

// the request; this value should be passed in a new `ListTopicsRequest`.

string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];

// Required. The name of the topic that subscriptions are attached to.

// Format is `projects/{project}/topics/{topic}`.

string topic = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }

];

// Optional. Maximum number of subscription names to return.

int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

string page_token = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. The names of subscriptions attached to the topic specified in the

// request.

repeated string subscriptions = 1 [

(google.api.field_behavior) = OPTIONAL,

(google.api.resource_reference) = {

type: "pubsub.googleapis.com/Subscription"

}

];

// Optional. 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.

string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];

// Required. The name of the topic that snapshots are attached to.

// Format is `projects/{project}/topics/{topic}`.

string topic = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }

];

// Optional. Maximum number of snapshot names to return.

int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

string page_token = 3 [(google.api.field_behavior) = OPTIONAL];

// Optional. The names of the snapshots that match the request.

repeated string snapshots = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];

// Required. Name of the topic to delete.

// Format is `projects/{project}/topics/{topic}`.

string topic = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }

];

// Required. The subscription to detach.

// Format is `projects/{project}/subscriptions/{subscription}`.

string subscription = 1 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = {

type: "pubsub.googleapis.com/Subscription"

}

];

option (google.api.default_host) = "pubsub.googleapis.com";

option (google.api.oauth_scopes) =

"https://www.googleapis.com/auth/cloud-platform,"

"https://www.googleapis.com/auth/pubsub";

// Creates a subscription to a given topic. See the [resource name rules]

// (https://cloud.google.com/pubsub/docs/pubsub-basics#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/pubsub-basics#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.

rpc CreateSubscription(Subscription) returns (Subscription) {

option (google.api.http) = {

put: "/v1/{name=projects/*/subscriptions/*}"

body: "*"

};

option (google.api.method_signature) =

"name,topic,push_config,ack_deadline_seconds";

}

// Gets the configuration details of a subscription.

rpc GetSubscription(GetSubscriptionRequest) returns (Subscription) {

option (google.api.http) = {

get: "/v1/{subscription=projects/*/subscriptions/*}"

};

option (google.api.method_signature) = "subscription";

}

// Updates an existing subscription by updating the fields specified in the

// update mask. Note that certain properties of a subscription, such as its

// topic, are not modifiable.

rpc UpdateSubscription(UpdateSubscriptionRequest) returns (Subscription) {

option (google.api.http) = {

patch: "/v1/{subscription.name=projects/*/subscriptions/*}"

body: "*"

};

option (google.api.method_signature) = "subscription,update_mask";

}

// Lists matching subscriptions.

rpc ListSubscriptions(ListSubscriptionsRequest)

returns (ListSubscriptionsResponse) {

option (google.api.http) = {

get: "/v1/{project=projects/*}/subscriptions"

};

option (google.api.method_signature) = "project";

}

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

rpc DeleteSubscription(DeleteSubscriptionRequest)

returns (google.protobuf.Empty) {

option (google.api.http) = {

delete: "/v1/{subscription=projects/*/subscriptions/*}"

};

option (google.api.method_signature) = "subscription";

}

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

rpc ModifyAckDeadline(ModifyAckDeadlineRequest)

returns (google.protobuf.Empty) {

option (google.api.http) = {

post: "/v1/{subscription=projects/*/subscriptions/*}:modifyAckDeadline"

body: "*"

};

option (google.api.method_signature) =

"subscription,ack_ids,ack_deadline_seconds";

}

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

rpc Acknowledge(AcknowledgeRequest) returns (google.protobuf.Empty) {

option (google.api.http) = {

post: "/v1/{subscription=projects/*/subscriptions/*}:acknowledge"

body: "*"

};

option (google.api.method_signature) = "subscription,ack_ids";

}

// Pulls messages from the server.

rpc Pull(PullRequest) returns (PullResponse) {

option (google.api.http) = {

post: "/v1/{subscription=projects/*/subscriptions/*}:pull"

body: "*"

};

option (google.api.method_signature) =

"subscription,return_immediately,max_messages";

option (google.api.method_signature) = "subscription,max_messages";

}

// 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 `UNAVAILABLE` to

// reassign server-side resources, in which case, the client should

// re-establish the stream. Flow control can be achieved by configuring the

// underlying RPC channel.

rpc StreamingPull(stream StreamingPullRequest)

returns (stream StreamingPullResponse) {}

// 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`.

rpc ModifyPushConfig(ModifyPushConfigRequest)

returns (google.protobuf.Empty) {

option (google.api.http) = {

post: "/v1/{subscription=projects/*/subscriptions/*}:modifyPushConfig"

body: "*"

};

option (google.api.method_signature) = "subscription,push_config";

}

// Gets the configuration details of a snapshot. 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.

rpc GetSnapshot(GetSnapshotRequest) returns (Snapshot) {

option (google.api.http) = {

get: "/v1/{snapshot=projects/*/snapshots/*}"

};

option (google.api.method_signature) = "snapshot";

}

// Lists the existing snapshots. 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.

rpc ListSnapshots(ListSnapshotsRequest) returns (ListSnapshotsResponse) {

option (google.api.http) = {

get: "/v1/{project=projects/*}/snapshots"

};

option (google.api.method_signature) = "project";

}

// Creates a snapshot from the requested subscription. 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.

// If the snapshot already exists, returns `ALREADY_EXISTS`.

// If the requested subscription doesn't exist, returns `NOT_FOUND`.

// If the backlog in the subscription is too old -- and the resulting snapshot

// would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.

// See also the `Snapshot.expire_time` field. 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, conforming

// to the [resource name format]

// (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The

// generated name is populated in the returned Snapshot object. Note that for

// REST API requests, you must specify a name in the request.

rpc CreateSnapshot(CreateSnapshotRequest) returns (Snapshot) {

option (google.api.http) = {

put: "/v1/{name=projects/*/snapshots/*}"

body: "*"

};

option (google.api.method_signature) = "name,subscription";

}

// Updates an existing snapshot by updating the fields specified in the update

// mask. 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.

rpc UpdateSnapshot(UpdateSnapshotRequest) returns (Snapshot) {

option (google.api.http) = {

patch: "/v1/{snapshot.name=projects/*/snapshots/*}"

body: "*"

};

option (google.api.method_signature) = "snapshot,update_mask";

}

// Removes an existing snapshot. 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.

// When the snapshot is deleted, all messages retained in the snapshot

// are immediately dropped. After a snapshot is deleted, a new one may be

// created with the same name, but the new one has no association with the old

// snapshot or its subscription, unless the same subscription is specified.

rpc DeleteSnapshot(DeleteSnapshotRequest) returns (google.protobuf.Empty) {

option (google.api.http) = {

delete: "/v1/{snapshot=projects/*/snapshots/*}"

};

option (google.api.method_signature) = "snapshot";

}

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

rpc Seek(SeekRequest) returns (SeekResponse) {

option (google.api.http) = {

post: "/v1/{subscription=projects/*/subscriptions/*}:seek"

body: "*"

};

}

option (google.api.resource) = {

type: "pubsub.googleapis.com/Subscription"

pattern: "projects/{project}/subscriptions/{subscription}"

};

// Possible states for a subscription.

enum State {

// Default value. This value is unused.

STATE_UNSPECIFIED = 0;

// The subscription can actively receive messages

ACTIVE = 1;

// The subscription cannot receive messages because of an error with the

// resource to which it pushes messages. See the more detailed error state

// in the corresponding configuration.

RESOURCE_ERROR = 2;

}

// 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"`.

string name = 1 [(google.api.field_behavior) = REQUIRED];

// Required. 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.

string topic = 2 [

(google.api.field_behavior) = REQUIRED,

(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }

];

// Optional. If push delivery is used with this subscription, this field is

// used to configure it.

PushConfig push_config = 4 [(google.api.field_behavior) = OPTIONAL];

// Optional. If delivery to BigQuery is used with this subscription, this

// field is used to configure it.

BigQueryConfig bigquery_config = 18 [(google.api.field_behavior) = OPTIONAL];

// Optional. If delivery to Google Cloud Storage is used with this

// subscription, this field is used to configure it.

CloudStorageConfig cloud_storage_config = 22

[(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

int32 ack_deadline_seconds = 5 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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]

// (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in

// the past to replay previously-acknowledged messages.

bool retain_acked_messages = 7 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

google.protobuf.Duration message_retention_duration = 8

[(google.api.field_behavior) = OPTIONAL];

// Optional. See [Creating and managing

// labels](https://cloud.google.com/pubsub/docs/labels).

map<string, string> labels = 9 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

bool enable_message_ordering = 10 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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. If `expiration_policy` is set,

// but `expiration_policy.ttl` is not set, the subscription never expires.

ExpirationPolicy expiration_policy = 11

[(google.api.field_behavior) = OPTIONAL];

// Optional. An expression written in the Pub/Sub [filter

// language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,

// then only `PubsubMessage`s whose `attributes` field matches the filter are

// delivered on this subscription. If empty, then no messages are filtered

// out.

string filter = 12 [(google.api.field_behavior) = OPTIONAL];

// Optional. A policy that specifies the conditions for dead lettering

// messages in this subscription. If dead_letter_policy is not set, dead

// lettering is disabled.

//

// The Pub/Sub service account associated with this subscriptions's

// parent project (i.e.,

// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have

// permission to Acknowledge() messages on this subscription.

DeadLetterPolicy dead_letter_policy = 13

[(google.api.field_behavior) = OPTIONAL];

// Optional. A policy that specifies how Pub/Sub retries message delivery for

// this subscription.

//

// If not set, the default retry policy is applied. This generally implies

// that messages will be retried as soon as possible for healthy subscribers.

// RetryPolicy will be triggered on NACKs or acknowledgement deadline

// exceeded events for a given message.

RetryPolicy retry_policy = 14 [(google.api.field_behavior) = OPTIONAL];

// Optional. Indicates whether the subscription is detached from its topic.

// Detached subscriptions don't receive messages from their topic and don't

// retain any backlog. `Pull` and `StreamingPull` requests will return

// FAILED_PRECONDITION. If the subscription is a push subscription, pushes to

// the endpoint will not be made.

bool detached = 15 [(google.api.field_behavior) = OPTIONAL];

// Optional. If true, Pub/Sub provides the following guarantees for the

// delivery of a message with a given value of `message_id` on this

// subscription:

//

// * The message sent to a subscriber is guaranteed not to be resent

// before the message's acknowledgement deadline expires.

// * An acknowledged message will not be resent to a subscriber.

//

// Note that subscribers may still receive multiple copies of a message

// when `enable_exactly_once_delivery` is true if the message was published

// multiple times by a publisher client. These copies are considered distinct

// by Pub/Sub and have distinct `message_id` values.

bool enable_exactly_once_delivery = 16

[(google.api.field_behavior) = OPTIONAL];

// Output only. Indicates the minimum duration for which a message is retained

// after it is published to the subscription's topic. If this field is set,

// messages published to the subscription's topic in the last

// `topic_message_retention_duration` are always available to subscribers. See

// the `message_retention_duration` field in `Topic`. This field is set only

// in responses from the server; it is ignored if it is set in any requests.

google.protobuf.Duration topic_message_retention_duration = 17

[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. An output-only field indicating whether or not the

// subscription can receive messages.

State state = 19 [(google.api.field_behavior) = OUTPUT_ONLY];

// Optional. The minimum delay between consecutive deliveries of a given

// message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

google.protobuf.Duration minimum_backoff = 1

[(google.api.field_behavior) = OPTIONAL];

// Optional. The maximum delay between consecutive deliveries of a given

// message. Value should be between 0 and 600 seconds. Defaults to 600

// seconds.

google.protobuf.Duration maximum_backoff = 2

[(google.api.field_behavior) = OPTIONAL];

// Optional. The name of the topic to which dead letter messages should be

// published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub

// service account associated with the enclosing subscription's parent project

// (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must

// have permission to Publish() to this topic.

//

// The operation will fail if the topic does not exist.

// Users should ensure that there is a subscription attached to this topic

// since messages published to a topic with no subscriptions are lost.

string dead_letter_topic = 1 [(google.api.field_behavior) = OPTIONAL];

// Optional. The maximum number of delivery attempts for any message. The

// value must be between 5 and 100.

//

// The number of delivery attempts is defined as 1 + (the sum of number of

// NACKs and number of times the acknowledgement deadline has been exceeded

// for the message).

//

// A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that

// client libraries may automatically extend ack_deadlines.

//

// This field will be honored on a best effort basis.

//

// If this parameter is 0, a default value of 5 is used.

int32 max_delivery_attempts = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. 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.

google.protobuf.Duration ttl = 1 [(google.api.field_behavior) = OPTIONAL];

// Contains information needed for generating an

// [OpenID Connect

// token](https://developers.google.com/identity/protocols/OpenIDConnect).