@google-cloud/pubsub-api 0.2.0

package/build/protos/google/pubsub/v1/pubsub.proto

@@ -0,0 +1,2588 @@
+// Copyright 2026 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.pubsub.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/duration.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+import "google/pubsub/v1/schema.proto";
+
+option csharp_namespace = "Google.Cloud.PubSub.V1";
+option go_package = "cloud.google.com/go/pubsub/v2/apiv1/pubsubpb;pubsubpb";
+option java_multiple_files = true;
+option java_outer_classname = "PubsubProto";
+option java_package = "com.google.pubsub.v1";
+option php_namespace = "Google\\Cloud\\PubSub\\V1";
+option ruby_package = "Google::Cloud::PubSub::V1";
+option (google.api.resource_definition) = {
+  type: "cloudkms.googleapis.com/CryptoKey"
+  pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}"
+};
+option (google.api.resource_definition) = {
+  type: "analyticshub.googleapis.com/Listing"
+  pattern: "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}"
+};
+
+// The service that an application uses to manipulate topics, and to send
+// messages to a topic.
+service Publisher {
+  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"
+    };
+  }
+}
+
+// A policy constraining the storage of messages published to the topic.
+message MessageStoragePolicy {
+  // 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];
+}
+
+// Settings for validating messages published against a schema.
+message SchemaSettings {
+  // 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];
+}
+
+// Settings for an ingestion data source on a topic.
+message IngestionDataSourceSettings {
+  // 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 if the 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];
+  }
+
+  // Ingestion settings for Cloud Storage.
+  message CloudStorage {
+    // Possible states for ingestion from Cloud Storage.
+    enum State {
+      // Default value. This value is unused.
+      STATE_UNSPECIFIED = 0;
+
+      // Ingestion is active.
+      ACTIVE = 1;
+
+      // Permission denied encountered while calling the Cloud Storage API. This
+      // can happen if the Pub/Sub SA has not been granted the
+      // [appropriate
+      // permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions):
+      // - storage.objects.list: to list the objects in a bucket.
+      // - storage.objects.get: to read the objects in a bucket.
+      // - storage.buckets.get: to verify the bucket exists.
+      CLOUD_STORAGE_PERMISSION_DENIED = 2;
+
+      // Permission denied encountered while publishing to the topic. This can
+      // happen if the 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 provided Cloud Storage bucket doesn't exist.
+      BUCKET_NOT_FOUND = 4;
+
+      // The Cloud Storage bucket has too many objects, ingestion will be
+      // paused.
+      TOO_MANY_OBJECTS = 5;
+    }
+
+    // Configuration for reading Cloud Storage data in text format. Each line of
+    // text as specified by the delimiter will be set to the `data` field of a
+    // Pub/Sub message.
+    message TextFormat {
+      // Optional. When unset, '\n' is used.
+      optional string delimiter = 1 [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // Configuration for reading Cloud Storage data in Avro binary format. The
+    // bytes of each object will be set to the `data` field of a Pub/Sub
+    // message.
+    message AvroFormat {}
+
+    // Configuration for reading Cloud Storage data written via [Cloud Storage
+    // subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The
+    // data and attributes fields of the originally exported Pub/Sub message
+    // will be restored when publishing.
+    message PubSubAvroFormat {}
+
+    // Output only. An output-only field that indicates the state of the Cloud
+    // Storage ingestion source.
+    State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Optional. Cloud Storage bucket. The bucket name must be without any
+    // prefix like "gs://". See the [bucket naming requirements]
+    // (https://cloud.google.com/storage/docs/buckets#naming).
+    string bucket = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Defaults to text format.
+    oneof input_format {
+      // Optional. Data from Cloud Storage will be interpreted as text.
+      TextFormat text_format = 3 [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Data from Cloud Storage will be interpreted in Avro format.
+      AvroFormat avro_format = 4 [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. It will be assumed data from Cloud Storage was written via
+      // [Cloud Storage
+      // subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
+      PubSubAvroFormat pubsub_avro_format = 5
+          [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // Optional. Only objects with a larger or equal creation timestamp will be
+    // ingested.
+    google.protobuf.Timestamp minimum_object_create_time = 6
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Glob pattern used to match objects that will be ingested. If
+    // unset, all objects will be ingested. See the [supported
+    // patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).
+    string match_glob = 9 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Ingestion settings for Azure Event Hubs.
+  message AzureEventHubs {
+    // Possible states for managed ingestion from Event Hubs.
+    enum State {
+      // Default value. This value is unused.
+      STATE_UNSPECIFIED = 0;
+
+      // Ingestion is active.
+      ACTIVE = 1;
+
+      // Permission denied encountered while consuming data from Event Hubs.
+      // This can happen when `client_id`, or `tenant_id` are invalid. Or the
+      // right permissions haven't been granted.
+      EVENT_HUBS_PERMISSION_DENIED = 2;
+
+      // Permission denied encountered while publishing to the topic.
+      PUBLISH_PERMISSION_DENIED = 3;
+
+      // The provided Event Hubs namespace couldn't be found.
+      NAMESPACE_NOT_FOUND = 4;
+
+      // The provided Event Hub couldn't be found.
+      EVENT_HUB_NOT_FOUND = 5;
+
+      // The provided Event Hubs subscription couldn't be found.
+      SUBSCRIPTION_NOT_FOUND = 6;
+
+      // The provided Event Hubs resource group couldn't be found.
+      RESOURCE_GROUP_NOT_FOUND = 7;
+    }
+
+    // Output only. An output-only field that indicates the state of the Event
+    // Hubs ingestion source.
+    State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Optional. Name of the resource group within the azure subscription.
+    string resource_group = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The name of the Event Hubs namespace.
+    string namespace = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The name of the Event Hub.
+    string event_hub = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The client id of the Azure application that is being used to
+    // authenticate Pub/Sub.
+    string client_id = 5 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The tenant id of the Azure application that is being used to
+    // authenticate Pub/Sub.
+    string tenant_id = 6 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The Azure subscription id.
+    string subscription_id = 7 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The GCP service account to be used for Federated Identity
+    // authentication.
+    string gcp_service_account = 8 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Ingestion settings for Amazon MSK.
+  message AwsMsk {
+    // Possible states for managed ingestion from Amazon MSK.
+    enum State {
+      // Default value. This value is unused.
+      STATE_UNSPECIFIED = 0;
+
+      // Ingestion is active.
+      ACTIVE = 1;
+
+      // Permission denied encountered while consuming data from Amazon MSK.
+      MSK_PERMISSION_DENIED = 2;
+
+      // Permission denied encountered while publishing to the topic.
+      PUBLISH_PERMISSION_DENIED = 3;
+
+      // The provided MSK cluster wasn't found.
+      CLUSTER_NOT_FOUND = 4;
+
+      // The provided topic wasn't found.
+      TOPIC_NOT_FOUND = 5;
+    }
+
+    // Output only. An output-only field that indicates the state of the Amazon
+    // MSK ingestion source.
+    State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Required. The Amazon Resource Name (ARN) that uniquely identifies the
+    // cluster.
+    string cluster_arn = 2 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The name of the topic in the Amazon MSK cluster that Pub/Sub
+    // will import from.
+    string topic = 3 [
+      (google.api.field_behavior) = REQUIRED,
+      (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
+    ];
+
+    // Required. AWS role ARN to be used for Federated Identity authentication
+    // with Amazon MSK. 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 Amazon MSK (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];
+  }
+
+  // Ingestion settings for Confluent Cloud.
+  message ConfluentCloud {
+    // Possible states for managed ingestion from Confluent Cloud.
+    enum State {
+      // Default value. This value is unused.
+      STATE_UNSPECIFIED = 0;
+
+      // Ingestion is active.
+      ACTIVE = 1;
+
+      // Permission denied encountered while consuming data from Confluent
+      // Cloud.
+      CONFLUENT_CLOUD_PERMISSION_DENIED = 2;
+
+      // Permission denied encountered while publishing to the topic.
+      PUBLISH_PERMISSION_DENIED = 3;
+
+      // The provided bootstrap server address is unreachable.
+      UNREACHABLE_BOOTSTRAP_SERVER = 4;
+
+      // The provided cluster wasn't found.
+      CLUSTER_NOT_FOUND = 5;
+
+      // The provided topic wasn't found.
+      TOPIC_NOT_FOUND = 6;
+    }
+
+    // Output only. An output-only field that indicates the state of the
+    // Confluent Cloud ingestion source.
+    State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Required. The address of the bootstrap server. The format is url:port.
+    string bootstrap_server = 2 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The id of the cluster.
+    string cluster_id = 3 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The name of the topic in the Confluent Cloud cluster that
+    // Pub/Sub will import from.
+    string topic = 4 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The id of the identity pool to be used for Federated Identity
+    // authentication with Confluent Cloud. See
+    // https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
+    string identity_pool_id = 5 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The GCP service account to be used for Federated Identity
+    // authentication with `identity_pool_id`.
+    string gcp_service_account = 6 [(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];
+
+    // Optional. Cloud Storage.
+    CloudStorage cloud_storage = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Azure Event Hubs.
+    AzureEventHubs azure_event_hubs = 3
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Amazon MSK.
+    AwsMsk aws_msk = 5 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Confluent Cloud.
+    ConfluentCloud confluent_cloud = 6 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Optional. Platform Logs settings. If unset, no Platform Logs will be
+  // generated.
+  PlatformLogsSettings platform_logs_settings = 4
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Settings for Platform Logs produced by Pub/Sub.
+message PlatformLogsSettings {
+  // Severity levels of Platform Logs.
+  enum Severity {
+    // Default value. Logs level is unspecified. Logs will be disabled.
+    SEVERITY_UNSPECIFIED = 0;
+
+    // Logs will be disabled.
+    DISABLED = 1;
+
+    // Debug logs and higher-severity logs will be written.
+    DEBUG = 2;
+
+    // Info logs and higher-severity logs will be written.
+    INFO = 3;
+
+    // Warning logs and higher-severity logs will be written.
+    WARNING = 4;
+
+    // Only error logs will be written.
+    ERROR = 5;
+  }
+
+  // Optional. The minimum severity level of Platform Logs that will be written.
+  Severity severity = 1 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Payload of the Platform Log entry sent when a failure is encountered while
+// ingesting.
+message IngestionFailureEvent {
+  // Specifies the reason why some data may have been left out of
+  // the desired Pub/Sub message due to the API message limits
+  // (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
+  // when the number of attributes is larger than 100, the number of
+  // attributes is truncated to 100 to respect the limit on the attribute count.
+  // Other attribute limits are treated similarly. When the size of the desired
+  // message would've been larger than 10MB, the message won't be published at
+  // all, and ingestion of the subsequent messages will proceed as normal.
+  message ApiViolationReason {}
+
+  // Set when an Avro file is unsupported or its format is not valid. When this
+  // occurs, one or more Avro objects won't be ingested.
+  message AvroFailureReason {}
+
+  // Set when a Pub/Sub message fails to get published due to a schema
+  // validation violation.
+  message SchemaViolationReason {}
+
+  // Set when a Pub/Sub message fails to get published due to a message
+  // transformation error.
+  message MessageTransformationFailureReason {}
+
+  // Failure when ingesting from a Cloud Storage source.
+  message CloudStorageFailure {
+    // Optional. Name of the Cloud Storage bucket used for ingestion.
+    string bucket = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Name of the Cloud Storage object which contained the section
+    // that couldn't be ingested.
+    string object_name = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Generation of the Cloud Storage object which contained the
+    // section that couldn't be ingested.
+    int64 object_generation = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Reason why ingestion failed for the specified object.
+    oneof reason {
+      // Optional. Failure encountered when parsing an Avro file.
+      AvroFailureReason avro_failure_reason = 5
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The Pub/Sub API limits prevented the desired message from
+      // being published.
+      ApiViolationReason api_violation_reason = 6
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The Pub/Sub message failed schema validation.
+      SchemaViolationReason schema_violation_reason = 7
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Failure encountered when applying a message transformation to
+      // the Pub/Sub message.
+      MessageTransformationFailureReason message_transformation_failure_reason =
+          8 [(google.api.field_behavior) = OPTIONAL];
+    }
+  }
+
+  // Failure when ingesting from an Amazon MSK source.
+  message AwsMskFailureReason {
+    // Optional. The ARN of the cluster of the topic being ingested from.
+    string cluster_arn = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The name of the Kafka topic being ingested from.
+    string kafka_topic = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The partition ID of the message that failed to be ingested.
+    int64 partition_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The offset within the partition of the message that failed to
+    // be ingested.
+    int64 offset = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Reason why ingestion failed for the specified message.
+    oneof reason {
+      // Optional. The Pub/Sub API limits prevented the desired message from
+      // being published.
+      ApiViolationReason api_violation_reason = 5
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The Pub/Sub message failed schema validation.
+      SchemaViolationReason schema_violation_reason = 6
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Failure encountered when applying a message transformation to
+      // the Pub/Sub message.
+      MessageTransformationFailureReason message_transformation_failure_reason =
+          7 [(google.api.field_behavior) = OPTIONAL];
+    }
+  }
+
+  // Failure when ingesting from an Azure Event Hubs source.
+  message AzureEventHubsFailureReason {
+    // Optional. The namespace containing the event hub being ingested from.
+    string namespace = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The name of the event hub being ingested from.
+    string event_hub = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The partition ID of the message that failed to be ingested.
+    int64 partition_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The offset within the partition of the message that failed to
+    // be ingested.
+    int64 offset = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Reason why ingestion failed for the specified message.
+    oneof reason {
+      // Optional. The Pub/Sub API limits prevented the desired message from
+      // being published.
+      ApiViolationReason api_violation_reason = 5
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The Pub/Sub message failed schema validation.
+      SchemaViolationReason schema_violation_reason = 6
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Failure encountered when applying a message transformation to
+      // the Pub/Sub message.
+      MessageTransformationFailureReason message_transformation_failure_reason =
+          7 [(google.api.field_behavior) = OPTIONAL];
+    }
+  }
+
+  // Failure when ingesting from a Confluent Cloud source.
+  message ConfluentCloudFailureReason {
+    // Optional. The cluster ID containing the topic being ingested from.
+    string cluster_id = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The name of the Kafka topic being ingested from.
+    string kafka_topic = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The partition ID of the message that failed to be ingested.
+    int64 partition_id = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The offset within the partition of the message that failed to
+    // be ingested.
+    int64 offset = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Reason why ingestion failed for the specified message.
+    oneof reason {
+      // Optional. The Pub/Sub API limits prevented the desired message from
+      // being published.
+      ApiViolationReason api_violation_reason = 5
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The Pub/Sub message failed schema validation.
+      SchemaViolationReason schema_violation_reason = 6
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Failure encountered when applying a message transformation to
+      // the Pub/Sub message.
+      MessageTransformationFailureReason message_transformation_failure_reason =
+          7 [(google.api.field_behavior) = OPTIONAL];
+    }
+  }
+
+  // Failure when ingesting from an AWS Kinesis source.
+  message AwsKinesisFailureReason {
+    // Optional. The stream ARN of the Kinesis stream being ingested from.
+    string stream_arn = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The partition key of the message that failed to be ingested.
+    string partition_key = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. The sequence number of the message that failed to be ingested.
+    string sequence_number = 3 [(google.api.field_behavior) = OPTIONAL];
+
+    // Reason why ingestion failed for the specified message.
+    oneof reason {
+      // Optional. The Pub/Sub message failed schema validation.
+      SchemaViolationReason schema_violation_reason = 4
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. Failure encountered when applying a message transformation to
+      // the Pub/Sub message.
+      MessageTransformationFailureReason message_transformation_failure_reason =
+          5 [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The message failed to be published due to an API violation.
+      // This is only set when the size of the data field of the Kinesis record
+      // is zero.
+      ApiViolationReason api_violation_reason = 6
+          [(google.api.field_behavior) = OPTIONAL];
+    }
+  }
+
+  // Required. Name of the import topic. Format is:
+  // projects/{project_name}/topics/{topic_name}.
+  string topic = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
+  ];
+
+  // Required. Error details explaining why ingestion to Pub/Sub has failed.
+  string error_message = 2 [(google.api.field_behavior) = REQUIRED];
+
+  oneof failure {
+    // Optional. Failure when ingesting from Cloud Storage.
+    CloudStorageFailure cloud_storage_failure = 3
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Failure when ingesting from Amazon MSK.
+    AwsMskFailureReason aws_msk_failure = 4
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Failure when ingesting from Azure Event Hubs.
+    AzureEventHubsFailureReason azure_event_hubs_failure = 5
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Failure when ingesting from Confluent Cloud.
+    ConfluentCloudFailureReason confluent_cloud_failure = 6
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Failure when ingesting from AWS Kinesis.
+    AwsKinesisFailureReason aws_kinesis_failure = 7
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+}
+
+// User-defined JavaScript function that can transform or filter a Pub/Sub
+// message.
+message JavaScriptUDF {
+  // Required. Name of the JavasScript function that should applied to Pub/Sub
+  // messages.
+  string function_name = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. JavaScript code that contains a function `function_name` with the
+  // below signature:
+  //
+  // ```
+  //   /**
+  //   * Transforms a Pub/Sub message.
+  //
+  //   * @return {(Object<string, (string | Object<string, string>)>|null)} - To
+  //   * filter a message, return `null`. To transform a message return a map
+  //   * with the following keys:
+  //   *   - (required) 'data' : {string}
+  //   *   - (optional) 'attributes' : {Object<string, string>}
+  //   * Returning empty `attributes` will remove all attributes from the
+  //   * message.
+  //   *
+  //   * @param  {(Object<string, (string | Object<string, string>)>} Pub/Sub
+  //   * message. Keys:
+  //   *   - (required) 'data' : {string}
+  //   *   - (required) 'attributes' : {Object<string, string>}
+  //   *
+  //   * @param  {Object<string, any>} metadata - Pub/Sub message metadata.
+  //   * Keys:
+  //   *   - (optional) 'message_id'  : {string}
+  //   *   - (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format
+  //   *   - (optional) 'ordering_key': {string}
+  //   */
+  //
+  //   function <function_name>(message, metadata) {
+  //   }
+  // ```
+  string code = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Configuration for making inference requests against Vertex AI models.
+message AIInference {
+  // Configuration for making inferences using arbitrary JSON payloads.
+  message UnstructuredInference {
+    // Optional. A parameters object to be included in each inference request.
+    // The parameters object is combined with the data field of the Pub/Sub
+    // message to form the inference request.
+    google.protobuf.Struct parameters = 1
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Required. An endpoint to a Vertex AI model of the form
+  // `projects/{project}/locations/{location}/endpoints/{endpoint}` or
+  // `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.
+  // Vertex AI API requests will be sent to this endpoint.
+  string endpoint = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // The format of inference requests made to the endpoint.
+  oneof inference_mode {
+    // Optional. Requests and responses can be any arbitrary JSON object.
+    UnstructuredInference unstructured_inference = 2
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Optional. The service account to use to make prediction requests against
+  // endpoints. The resource creator or updater that specifies this field must
+  // have `iam.serviceAccounts.actAs` permission on the service account. If not
+  // specified, the Pub/Sub [service
+  // agent](https://cloud.google.com/iam/docs/service-agents),
+  // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
+  string service_account_email = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// All supported message transforms types.
+message MessageTransform {
+  // The type of transform to apply to messages.
+  oneof transform {
+    // Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's
+    // are specified on a resource, each must have a unique `function_name`.
+    JavaScriptUDF javascript_udf = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. AI Inference. Specifies the Vertex AI endpoint that inference
+    // requests built from the Pub/Sub message data and provided parameters will
+    // be sent to.
+    AIInference ai_inference = 6 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Optional. This field is deprecated, use the `disabled` field to disable
+  // transforms.
+  bool enabled = 3 [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+
+  // Optional. If true, the transform is disabled and will not be applied to
+  // messages. Defaults to `false`.
+  bool disabled = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A topic resource.
+message Topic {
+  option (google.api.resource) = {
+    type: "pubsub.googleapis.com/Topic"
+    pattern: "projects/{project}/topics/{topic}"
+    pattern: "_deleted-topic_"
+    plural: "topics"
+    singular: "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. Identifier. 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,
+    (google.api.field_behavior) = IDENTIFIER
+  ];
+
+  // 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,
+    (google.api.resource_reference) = {
+      type: "cloudkms.googleapis.com/CryptoKey"
+    }
+  ];
+
+  // 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. Transforms to be applied to messages published to the topic.
+  // Transforms are applied in the order specified.
+  repeated MessageTransform message_transforms = 13
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Input only. Immutable. Tag keys/values directly bound to this
+  // resource. For example:
+  //   "123/environment": "production",
+  //   "123/costCenter": "marketing"
+  // See https://docs.cloud.google.com/pubsub/docs/tags for more information on
+  // using tags with Pub/Sub resources.
+  map<string, string> tags = 14 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// 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](https://cloud.google.com/pubsub/docs/reference/libraries) for
+// more information. See [quotas and limits]
+// (https://cloud.google.com/pubsub/quotas) for more information about message
+// limits.
+message PubsubMessage {
+  // 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];
+}
+
+// Request for the GetTopic method.
+message GetTopicRequest {
+  // 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" }
+  ];
+}
+
+// Request for the UpdateTopic method.
+message UpdateTopicRequest {
+  // 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];
+}
+
+// Request for the Publish method.
+message PublishRequest {
+  // 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];
+}
+
+// Response for the `Publish` method.
+message PublishResponse {
+  // 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];
+}
+
+// Request for the `ListTopics` method.
+message ListTopicsRequest {
+  // 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];
+}
+
+// Response for the `ListTopics` method.
+message ListTopicsResponse {
+  // 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];
+}
+
+// Request for the `ListTopicSubscriptions` method.
+message ListTopicSubscriptionsRequest {
+  // 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];
+}
+
+// Response for the `ListTopicSubscriptions` method.
+message ListTopicSubscriptionsResponse {
+  // 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];
+}
+
+// Request for the `ListTopicSnapshots` method.
+message ListTopicSnapshotsRequest {
+  // 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];
+}
+
+// Response for the `ListTopicSnapshots` method.
+message ListTopicSnapshotsResponse {
+  // Optional. The names of the snapshots that match the request.
+  repeated string snapshots = 1 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
+  ];
+
+  // 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];
+}
+
+// Request for the `DeleteTopic` method.
+message DeleteTopicRequest {
+  // 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" }
+  ];
+}
+
+// Request for the DetachSubscription method.
+message DetachSubscriptionRequest {
+  // 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"
+    }
+  ];
+}
+
+// Response for the DetachSubscription method.
+// Reserved for future use.
+message DetachSubscriptionResponse {}
+
+// 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.
+service Subscriber {
+  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 acknowledgments 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: "*"
+    };
+  }
+}
+
+// A subscription resource. If none of `push_config`, `bigquery_config`, or
+// `cloud_storage_config` is set, then the subscriber will pull and ack messages
+// using API methods. At most one of these fields may be set.
+message Subscription {
+  option (google.api.resource) = {
+    type: "pubsub.googleapis.com/Subscription"
+    pattern: "projects/{project}/subscriptions/{subscription}"
+    plural: "subscriptions"
+    singular: "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;
+  }
+
+  // Information about an associated [Analytics Hub
+  // subscription](https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).
+  message AnalyticsHubSubscriptionInfo {
+    // Optional. The name of the associated Analytics Hub listing resource.
+    // Pattern:
+    // "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}"
+    string listing = 1 [
+      (google.api.field_behavior) = OPTIONAL,
+      (google.api.resource_reference) = {
+        type: "analyticshub.googleapis.com/Listing"
+      }
+    ];
+
+    // Optional. The name of the associated Analytics Hub subscription resource.
+    // Pattern:
+    // "projects/{project}/locations/{location}/subscriptions/{subscription}"
+    string subscription = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Required. Identifier. 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,
+    (google.api.field_behavior) = IDENTIFIER
+  ];
+
+  // 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. If delivery to Bigtable is used with this subscription, this
+  // field is used to configure it.
+  BigtableConfig bigtable_config = 27 [(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 31 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 acknowledgment 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 acknowledgment 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];
+
+  // Output only. Information about the associated Analytics Hub subscription.
+  // Only set if the subscription is created by Analytics Hub.
+  AnalyticsHubSubscriptionInfo analytics_hub_subscription_info = 23
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Transforms to be applied to messages before they are delivered to
+  // subscribers. Transforms are applied in the order specified.
+  repeated MessageTransform message_transforms = 25
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Input only. Immutable. Tag keys/values directly bound to this
+  // resource. For example:
+  //   "123/environment": "production",
+  //   "123/costCenter": "marketing"
+  // See https://docs.cloud.google.com/pubsub/docs/tags for more information on
+  // using tags with Pub/Sub resources.
+  map<string, string> tags = 26 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// A policy that specifies how Pub/Sub retries message delivery.
+//
+// Retry delay will be exponential based on provided minimum and maximum
+// backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
+//
+// RetryPolicy will be triggered on NACKs or acknowledgment deadline exceeded
+// events for a given message.
+//
+// Retry Policy is implemented on a best effort basis. At times, the delay
+// between consecutive deliveries may not match the configuration. That is,
+// delay can be more or less than configured backoff.
+message RetryPolicy {
+  // 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];
+}
+
+// Dead lettering is done on a best effort basis. The same message might be
+// dead lettered multiple times.
+//
+// If validation on any of the fields fails at subscription creation/updation,
+// the create/update subscription request will fail.
+message DeadLetterPolicy {
+  // 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,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
+  ];
+
+  // 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 acknowledgment 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];
+}
+
+// A policy that specifies the conditions for resource expiration (i.e.,
+// automatic resource deletion).
+message ExpirationPolicy {
+  // 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];
+}
+
+// Configuration for a push delivery endpoint.
+message PushConfig {
+  // Contains information needed for generating an
+  // [OpenID Connect
+  // token](https://developers.google.com/identity/protocols/OpenIDConnect).
+  message OidcToken {
+    // Optional. [Service account
+    // email](https://cloud.google.com/iam/docs/service-accounts)
+    // used for generating the OIDC token. For more information
+    // on setting up authentication, see
+    // [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
+    string service_account_email = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. 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.
+    string audience = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // The payload to the push endpoint is in the form of the JSON representation
+  // of a PubsubMessage
+  // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
+  message PubsubWrapper {}
+
+  // Sets the `data` field as the HTTP body for delivery.
+  message NoWrapper {
+    // Optional. When true, writes the Pub/Sub message metadata to
+    // `x-goog-pubsub-<KEY>:<VAL>` headers of the HTTP request. Writes the
+    // Pub/Sub message attributes to `<KEY>:<VAL>` headers of the HTTP request.
+    bool write_metadata = 1 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Optional. A URL locating the endpoint to which messages should be pushed.
+  // For example, a Webhook endpoint might use `https://example.com/push`.
+  string push_endpoint = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. 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" }`
+  map<string, string> attributes = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // An authentication method used by push endpoints to verify the source of
+  // push requests. This can be used with push endpoints that are private by
+  // default to allow requests only from the Pub/Sub system, for example.
+  // This field is optional and should be set only by users interested in
+  // authenticated push.
+  oneof authentication_method {
+    // Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
+    // token as an `Authorization` header in the HTTP request for every pushed
+    // message.
+    OidcToken oidc_token = 3 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // The format of the delivered message to the push endpoint is defined by
+  // the chosen wrapper. When unset, `PubsubWrapper` is used.
+  oneof wrapper {
+    // Optional. When set, the payload to the push endpoint is in the form of
+    // the JSON representation of a PubsubMessage
+    // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
+    PubsubWrapper pubsub_wrapper = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. When set, the payload to the push endpoint is not wrapped.
+    NoWrapper no_wrapper = 5 [(google.api.field_behavior) = OPTIONAL];
+  }
+}
+
+// Configuration for a BigQuery subscription.
+message BigQueryConfig {
+  // Possible states for a BigQuery subscription.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The subscription can actively send messages to BigQuery
+    ACTIVE = 1;
+
+    // Cannot write to the BigQuery table because of permission denied errors.
+    // This can happen if
+    // - Pub/Sub SA has not been granted the [appropriate BigQuery IAM
+    // permissions](https://cloud.google.com/pubsub/docs/create-subscription#assign_bigquery_service_account)
+    // - bigquery.googleapis.com API is not enabled for the project
+    // ([instructions](https://cloud.google.com/service-usage/docs/enable-disable))
+    PERMISSION_DENIED = 2;
+
+    // Cannot write to the BigQuery table because it does not exist.
+    NOT_FOUND = 3;
+
+    // Cannot write to the BigQuery table due to a schema mismatch.
+    SCHEMA_MISMATCH = 4;
+
+    // Cannot write to the destination because enforce_in_transit is set to true
+    // and the destination locations are not in the allowed regions.
+    IN_TRANSIT_LOCATION_RESTRICTION = 5;
+
+    // Cannot write to the BigQuery table because the table is not in the same
+    // location as where Vertex AI models used in `message_transform`s are
+    // deployed.
+    VERTEX_AI_LOCATION_RESTRICTION = 6;
+  }
+
+  // Optional. The name of the table to which to write data, of the form
+  // {projectId}.{datasetId}.{tableId}
+  string table = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. When true, use the topic's schema as the columns to write to in
+  // BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be
+  // enabled at the same time.
+  bool use_topic_schema = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. When true, write the subscription name, message_id, publish_time,
+  // attributes, and ordering_key to additional columns in the table. The
+  // subscription name, message_id, and publish_time fields are put in their own
+  // columns while all other message properties (other than data) are written to
+  // a JSON object in the attributes column.
+  bool write_metadata = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. When true and use_topic_schema is true, any fields that are a
+  // part of the topic schema that are not part of the BigQuery table schema are
+  // dropped when writing to BigQuery. Otherwise, the schemas must be kept in
+  // sync and any messages with extra fields are not written and remain in the
+  // subscription's backlog.
+  bool drop_unknown_fields = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. An output-only field that indicates whether or not the
+  // subscription can receive messages.
+  State state = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. When true, use the BigQuery table's schema as the columns to
+  // write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be
+  // enabled at the same time.
+  bool use_table_schema = 6 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The service account to use to write to BigQuery. The subscription
+  // creator or updater that specifies this field must have
+  // `iam.serviceAccounts.actAs` permission on the service account. If not
+  // specified, the Pub/Sub [service
+  // agent](https://cloud.google.com/iam/docs/service-agents),
+  // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
+  string service_account_email = 7 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Configuration for a Bigtable subscription. The Pub/Sub message will be
+// written to a Bigtable row as follows:
+// - row key: subscription name and message ID delimited by #.
+// - columns: message bytes written to a single column family "data" with an
+//   empty-string column qualifier.
+// - cell timestamp: the message publish timestamp.
+message BigtableConfig {
+  // Possible states for a Bigtable subscription.
+  // Note: more states could be added in the future. Please code accordingly.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The subscription can actively send messages to Bigtable.
+    ACTIVE = 1;
+
+    // Cannot write to Bigtable because the instance, table, or app profile
+    // does not exist.
+    NOT_FOUND = 2;
+
+    // Cannot write to Bigtable because the app profile is not configured for
+    // single-cluster routing.
+    APP_PROFILE_MISCONFIGURED = 3;
+
+    // Cannot write to Bigtable because of permission denied errors.
+    // This can happen if:
+    // - The Pub/Sub service agent has not been granted the
+    //   [appropriate Bigtable IAM permission
+    //   bigtable.tables.mutateRows]({$universe.dns_names.final_documentation_domain}/bigtable/docs/access-control#permissions)
+    // - The bigtable.googleapis.com API is not enabled for the project
+    //   ([instructions]({$universe.dns_names.final_documentation_domain}/service-usage/docs/enable-disable))
+    PERMISSION_DENIED = 4;
+
+    // Cannot write to Bigtable because of a missing column family ("data") or
+    // if there is no structured row key for the subscription name + message ID.
+    SCHEMA_MISMATCH = 5;
+
+    // Cannot write to the destination because enforce_in_transit is set to true
+    // and the destination locations are not in the allowed regions.
+    IN_TRANSIT_LOCATION_RESTRICTION = 6;
+
+    // Cannot write to Bigtable because the table is not in the same location as
+    // where Vertex AI models used in `message_transform`s are deployed.
+    VERTEX_AI_LOCATION_RESTRICTION = 7;
+  }
+
+  // Optional. The unique name of the table to write messages to.
+  //
+  // Values are of the form
+  // `projects/<project>/instances/<instance>/tables/<table>`.
+  string table = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The app profile to use for the Bigtable writes. If not specified,
+  // the "default" application profile will be used. The app profile must use
+  // single-cluster routing.
+  string app_profile_id = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The service account to use to write to Bigtable. The subscription
+  // creator or updater that specifies this field must have
+  // `iam.serviceAccounts.actAs` permission on the service account. If not
+  // specified, the Pub/Sub [service
+  // agent](https://cloud.google.com/iam/docs/service-agents),
+  // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
+  string service_account_email = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. When true, write the subscription name, message_id, publish_time,
+  // attributes, and ordering_key to additional columns in the table under the
+  // pubsub_metadata column family. The subscription name, message_id, and
+  // publish_time fields are put in their own columns while all other message
+  // properties (other than data) are written to a JSON object in the attributes
+  // column.
+  bool write_metadata = 5 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. An output-only field that indicates whether or not the
+  // subscription can receive messages.
+  State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Configuration for a Cloud Storage subscription.
+message CloudStorageConfig {
+  // Configuration for writing message data in text format.
+  // Message payloads will be written to files as raw text, separated by a
+  // newline.
+  message TextConfig {}
+
+  // Configuration for writing message data in Avro format.
+  // Message payloads and metadata will be written to files as an Avro binary.
+  message AvroConfig {
+    // Optional. When true, write the subscription name, message_id,
+    // publish_time, attributes, and ordering_key as additional fields in the
+    // output. The subscription name, message_id, and publish_time fields are
+    // put in their own fields while all other message properties other than
+    // data (for example, an ordering_key, if present) are added as entries in
+    // the attributes map.
+    bool write_metadata = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. When true, the output Cloud Storage file will be serialized
+    // using the topic schema, if it exists.
+    bool use_topic_schema = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Possible states for a Cloud Storage subscription.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The subscription can actively send messages to Cloud Storage.
+    ACTIVE = 1;
+
+    // Cannot write to the Cloud Storage bucket because of permission denied
+    // errors.
+    PERMISSION_DENIED = 2;
+
+    // Cannot write to the Cloud Storage bucket because it does not exist.
+    NOT_FOUND = 3;
+
+    // Cannot write to the destination because enforce_in_transit is set to true
+    // and the destination locations are not in the allowed regions.
+    IN_TRANSIT_LOCATION_RESTRICTION = 4;
+
+    // Cannot write to the Cloud Storage bucket due to an incompatibility
+    // between the topic schema and subscription settings.
+    SCHEMA_MISMATCH = 5;
+
+    // Cannot write to the Cloud Storage bucket because the bucket is not in the
+    // same location as where Vertex AI models used in `message_transform`s are
+    // deployed.
+    VERTEX_AI_LOCATION_RESTRICTION = 6;
+  }
+
+  // Required. User-provided name for the Cloud Storage bucket.
+  // The bucket must be created by the user. The bucket name must be without
+  // any prefix like "gs://". See the [bucket naming
+  // requirements] (https://cloud.google.com/storage/docs/buckets#naming).
+  string bucket = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. User-provided prefix for Cloud Storage filename. See the [object
+  // naming requirements](https://cloud.google.com/storage/docs/objects#naming).
+  string filename_prefix = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. User-provided suffix for Cloud Storage filename. See the [object
+  // naming requirements](https://cloud.google.com/storage/docs/objects#naming).
+  // Must not end in "/".
+  string filename_suffix = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. User-provided format string specifying how to represent datetimes
+  // in Cloud Storage filenames. See the [datetime format
+  // guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-subscription#file_names).
+  string filename_datetime_format = 10 [(google.api.field_behavior) = OPTIONAL];
+
+  // Defaults to text format.
+  oneof output_format {
+    // Optional. If set, message data will be written to Cloud Storage in text
+    // format.
+    TextConfig text_config = 4 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. If set, message data will be written to Cloud Storage in Avro
+    // format.
+    AvroConfig avro_config = 5 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Optional. The maximum duration that can elapse before a new Cloud Storage
+  // file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
+  // exceed the subscription's acknowledgment deadline.
+  google.protobuf.Duration max_duration = 6
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The maximum bytes that can be written to a Cloud Storage file
+  // before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
+  // be exceeded in cases where messages are larger than the limit.
+  int64 max_bytes = 7 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The maximum number of messages that can be written to a Cloud
+  // Storage file before a new file is created. Min 1000 messages.
+  int64 max_messages = 8 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. An output-only field that indicates whether or not the
+  // subscription can receive messages.
+  State state = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The service account to use to write to Cloud Storage. The
+  // subscription creator or updater that specifies this field must have
+  // `iam.serviceAccounts.actAs` permission on the service account. If not
+  // specified, the Pub/Sub
+  // [service agent](https://cloud.google.com/iam/docs/service-agents),
+  // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
+  string service_account_email = 11 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// A message and its corresponding acknowledgment ID.
+message ReceivedMessage {
+  // Optional. This ID can be used to acknowledge the received message.
+  string ack_id = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The message.
+  PubsubMessage message = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The approximate number of times that Pub/Sub has attempted to
+  // deliver the associated message to a subscriber.
+  //
+  // More precisely, this is 1 + (number of NACKs) +
+  // (number of ack_deadline exceeds) for this message.
+  //
+  // A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
+  // exceeds event is whenever a message is not acknowledged within
+  // ack_deadline. Note that ack_deadline is initially
+  // Subscription.ackDeadlineSeconds, but may get extended automatically by
+  // the client library.
+  //
+  // Upon the first delivery of a given message, `delivery_attempt` will have a
+  // value of 1. The value is calculated at best effort and is approximate.
+  //
+  // If a DeadLetterPolicy is not set on the subscription, this will be 0.
+  int32 delivery_attempt = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the GetSubscription method.
+message GetSubscriptionRequest {
+  // Required. The name of the subscription to get.
+  // Format is `projects/{project}/subscriptions/{sub}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+}
+
+// Request for the UpdateSubscription method.
+message UpdateSubscriptionRequest {
+  // Required. The updated subscription object.
+  Subscription subscription = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Indicates which fields in the provided subscription to update.
+  // Must be specified and non-empty.
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request for the `ListSubscriptions` method.
+message ListSubscriptionsRequest {
+  // Required. The name of the project in which to list subscriptions.
+  // 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 subscriptions to return.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. 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.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response for the `ListSubscriptions` method.
+message ListSubscriptionsResponse {
+  // Optional. The subscriptions that match the request.
+  repeated Subscription subscriptions = 1
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. 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.
+  string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the DeleteSubscription method.
+message DeleteSubscriptionRequest {
+  // Required. The subscription to delete.
+  // Format is `projects/{project}/subscriptions/{sub}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+}
+
+// Request for the ModifyPushConfig method.
+message ModifyPushConfigRequest {
+  // Required. The name of the subscription.
+  // Format is `projects/{project}/subscriptions/{sub}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  // Required. 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.
+  PushConfig push_config = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request for the `Pull` method.
+message PullRequest {
+  // Required. The subscription from which messages should be pulled.
+  // Format is `projects/{project}/subscriptions/{sub}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  // Optional. 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.
+  // Warning: setting this field to `true` is discouraged because it adversely
+  // impacts the performance of `Pull` operations. We recommend that users do
+  // not set this field.
+  bool return_immediately = 2
+      [deprecated = true, (google.api.field_behavior) = OPTIONAL];
+
+  // Required. The maximum number of messages to return for this request. Must
+  // be a positive integer. The Pub/Sub system may return fewer than the number
+  // specified.
+  int32 max_messages = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response for the `Pull` method.
+message PullResponse {
+  // Optional. Received Pub/Sub messages. The list will be empty if there are no
+  // more messages available in the backlog, or if no messages could be returned
+  // before the request timeout. 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.
+  repeated ReceivedMessage received_messages = 1
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the ModifyAckDeadline method.
+message ModifyAckDeadlineRequest {
+  // Required. The name of the subscription.
+  // Format is `projects/{project}/subscriptions/{sub}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  // Required. List of acknowledgment IDs.
+  repeated string ack_ids = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. 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 in a single request is 600 seconds
+  // (10 minutes).
+  int32 ack_deadline_seconds = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request for the Acknowledge method.
+message AcknowledgeRequest {
+  // Required. The subscription whose message is being acknowledged.
+  // Format is `projects/{project}/subscriptions/{sub}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  // Required. The acknowledgment ID for the messages being acknowledged that
+  // was returned by the Pub/Sub system in the `Pull` response. Must not be
+  // empty.
+  repeated string ack_ids = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request for the `StreamingPull` streaming RPC method. This request is used to
+// establish the initial stream as well as to stream acknowledgments and ack
+// deadline modifications from the client to the server.
+message StreamingPullRequest {
+  // Required. 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}`.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  // Optional. List of acknowledgment 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 acknowledgment
+  // ID is malformed, the stream will be aborted with status `INVALID_ARGUMENT`.
+  repeated string ack_ids = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. 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`.
+  repeated int32 modify_deadline_seconds = 3
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. List of acknowledgment 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.
+  repeated string modify_deadline_ack_ids = 4
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Required. 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).
+  int32 stream_ack_deadline_seconds = 5
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. A unique identifier that is used to distinguish client instances
+  // from each other. Only needs to be provided on the initial request. When a
+  // stream disconnects and reconnects for the same stream, the client_id should
+  // be set to the same value so that state associated with the old stream can
+  // be transferred to the new stream. The same client_id should not be used for
+  // different client instances.
+  string client_id = 6 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Flow control settings for the maximum number of outstanding
+  // messages. When there are `max_outstanding_messages` currently sent to the
+  // streaming pull client that have not yet been acked or nacked, the server
+  // stops sending more messages. The sending of messages resumes once the
+  // number of outstanding messages is less than this value. If the value is
+  // <= 0, there is no limit to the number of outstanding messages. This
+  // property can only be set on the initial StreamingPullRequest. If it is set
+  // on a subsequent request, the stream will be aborted with status
+  // `INVALID_ARGUMENT`.
+  int64 max_outstanding_messages = 7 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Flow control settings for the maximum number of outstanding
+  // bytes. When there are `max_outstanding_bytes` or more worth of messages
+  // currently sent to the streaming pull client that have not yet been acked or
+  // nacked, the server will stop sending more messages. The sending of messages
+  // resumes once the number of outstanding bytes is less than this value. If
+  // the value is <= 0, there is no limit to the number of outstanding bytes.
+  // This property can only be set on the initial StreamingPullRequest. If it is
+  // set on a subsequent request, the stream will be aborted with status
+  // `INVALID_ARGUMENT`.
+  int64 max_outstanding_bytes = 8 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The protocol version used by the client. This property can only
+  // be set on the initial StreamingPullRequest. If it is set on a subsequent
+  // request, the stream will be aborted with status `INVALID_ARGUMENT`.
+  int64 protocol_version = 10 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response for the `StreamingPull` method. This response is used to stream
+// messages from the server to the client.
+message StreamingPullResponse {
+  // Acknowledgment IDs sent in one or more previous requests to acknowledge a
+  // previously received message.
+  message AcknowledgeConfirmation {
+    // Optional. Successfully processed acknowledgment IDs.
+    repeated string ack_ids = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgment IDs that were malformed or whose
+    // acknowledgment deadline has expired.
+    repeated string invalid_ack_ids = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgment IDs that were out of order.
+    repeated string unordered_ack_ids = 3
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgment IDs that failed processing with
+    // temporary issues.
+    repeated string temporary_failed_ack_ids = 4
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Acknowledgment IDs sent in one or more previous requests to modify the
+  // deadline for a specific message.
+  message ModifyAckDeadlineConfirmation {
+    // Optional. Successfully processed acknowledgment IDs.
+    repeated string ack_ids = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgment IDs that were malformed or whose
+    // acknowledgment deadline has expired.
+    repeated string invalid_ack_ids = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgment IDs that failed processing with
+    // temporary issues.
+    repeated string temporary_failed_ack_ids = 3
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Subscription properties sent as part of the response.
+  message SubscriptionProperties {
+    // Optional. True iff exactly once delivery is enabled for this
+    // subscription.
+    bool exactly_once_delivery_enabled = 1
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. True iff message ordering is enabled for this subscription.
+    bool message_ordering_enabled = 2 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Optional. Received Pub/Sub messages.
+  repeated ReceivedMessage received_messages = 1
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. This field will only be set if `enable_exactly_once_delivery` is
+  // set to `true` and is not guaranteed to be populated.
+  AcknowledgeConfirmation acknowledge_confirmation = 5
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. This field will only be set if `enable_exactly_once_delivery` is
+  // set to `true` and is not guaranteed to be populated.
+  ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Properties associated with this subscription.
+  SubscriptionProperties subscription_properties = 4
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the `CreateSnapshot` method.
+message CreateSnapshotRequest {
+  // Required. 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](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
+  // Format is `projects/{project}/snapshots/{snap}`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
+  ];
+
+  // Required. 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}`.
+  string subscription = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  // Optional. See [Creating and managing
+  // labels](https://cloud.google.com/pubsub/docs/labels).
+  map<string, string> labels = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Input only. Immutable. Tag keys/values directly bound to this
+  // resource. For example:
+  //   "123/environment": "production",
+  //   "123/costCenter": "marketing"
+  // See https://docs.cloud.google.com/pubsub/docs/tags for more information on
+  // using tags with Pub/Sub resources.
+  map<string, string> tags = 4 [
+    (google.api.field_behavior) = INPUT_ONLY,
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// Request for the UpdateSnapshot method.
+message UpdateSnapshotRequest {
+  // Required. The updated snapshot object.
+  Snapshot snapshot = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. Indicates which fields in the provided snapshot to update.
+  // Must be specified and non-empty.
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// A snapshot resource. 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.
+message Snapshot {
+  option (google.api.resource) = {
+    type: "pubsub.googleapis.com/Snapshot"
+    pattern: "projects/{project}/snapshots/{snapshot}"
+    plural: "snapshots"
+    singular: "snapshot"
+  };
+
+  // Optional. The name of the snapshot.
+  string name = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The name of the topic from which this snapshot is retaining
+  // messages.
+  string topic = 2 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
+  ];
+
+  // Optional. 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.
+  google.protobuf.Timestamp expire_time = 3
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. See [Creating and managing labels]
+  // (https://cloud.google.com/pubsub/docs/labels).
+  map<string, string> labels = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the GetSnapshot method.
+message GetSnapshotRequest {
+  // Required. The name of the snapshot to get.
+  // Format is `projects/{project}/snapshots/{snap}`.
+  string snapshot = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
+  ];
+}
+
+// Request for the `ListSnapshots` method.
+message ListSnapshotsRequest {
+  // Required. The name of the project in which to list snapshots.
+  // 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 snapshots to return.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. 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.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response for the `ListSnapshots` method.
+message ListSnapshotsResponse {
+  // Optional. The resulting snapshots.
+  repeated Snapshot snapshots = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. If not empty, indicates that there may be more snapshot that
+  // match the request; this value should be passed in a new
+  // `ListSnapshotsRequest`.
+  string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the `DeleteSnapshot` method.
+message DeleteSnapshotRequest {
+  // Required. The name of the snapshot to delete.
+  // Format is `projects/{project}/snapshots/{snap}`.
+  string snapshot = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = { type: "pubsub.googleapis.com/Snapshot" }
+  ];
+}
+
+// Request for the `Seek` method.
+message SeekRequest {
+  // Required. The subscription to affect.
+  string subscription = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "pubsub.googleapis.com/Subscription"
+    }
+  ];
+
+  oneof target {
+    // Optional. 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.
+    google.protobuf.Timestamp time = 2 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. 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}`.
+    string snapshot = 3 [
+      (google.api.field_behavior) = OPTIONAL,
+      (google.api.resource_reference) = {
+        type: "pubsub.googleapis.com/Snapshot"
+      }
+    ];
+  }
+}
+
+// Response for the `Seek` method (this response is empty).
+message SeekResponse {}