@google-cloud/pubsub 4.1.1 → 4.3.0

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

@@ -53,8 +53,8 @@ service Publisher {
     option (google.api.method_signature) = "name";
   }
 
-  // Updates an existing topic. Note that certain properties of a
-  // topic are not modifiable.
+  // 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/*}"
@@ -137,13 +137,21 @@ service Publisher {
 
 // A policy constraining the storage of messages published to the topic.
 message MessageStoragePolicy {
-  // 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;
+  // 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.
@@ -157,18 +165,83 @@ message SchemaSettings {
     (google.api.resource_reference) = { type: "pubsub.googleapis.com/Schema" }
   ];
 
-  // The encoding of messages validated against `schema`.
-  Encoding encoding = 2;
+  // Optional. The encoding of messages validated against `schema`.
+  Encoding encoding = 2 [(google.api.field_behavior) = 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;
+  // 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];
 
-  // 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;
+  // 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 managed ingestion from Amazon Kinesis Data Streams.
+    enum State {
+      // Default value. This value is unused.
+      STATE_UNSPECIFIED = 0;
+
+      // Ingestion is active.
+      ACTIVE = 1;
+
+      // Permission denied encountered while consuming data from Kinesis.
+      // This can happen if:
+      //   - The provided `aws_role_arn` does not exist or does not have the
+      //     appropriate permissions attached.
+      //   - The provided `aws_role_arn` is not set up properly for Identity
+      //     Federation using `gcp_service_account`.
+      //   - The Pub/Sub SA is not granted the
+      //     `iam.serviceAccounts.getOpenIdToken` permission on
+      //     `gcp_service_account`.
+      KINESIS_PERMISSION_DENIED = 2;
+
+      // Permission denied encountered while publishing to the topic. This can
+      // happen due to Pub/Sub SA has not been granted the [appropriate publish
+      // permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)
+      PUBLISH_PERMISSION_DENIED = 3;
+
+      // The Kinesis stream does not exist.
+      STREAM_NOT_FOUND = 4;
+
+      // The Kinesis consumer does not exist.
+      CONSUMER_NOT_FOUND = 5;
+    }
+
+    // Output only. An output-only field that indicates the state of the Kinesis
+    // ingestion source.
+    State state = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Required. The Kinesis stream ARN to ingest data from.
+    string stream_arn = 2 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The Kinesis consumer ARN to used for ingestion in Enhanced
+    // Fan-Out mode. The consumer must be already created and ready to be used.
+    string consumer_arn = 3 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. AWS role ARN to be used for Federated Identity authentication
+    // with Kinesis. Check the Pub/Sub docs for how to set up this role and the
+    // required permissions that need to be attached to it.
+    string aws_role_arn = 4 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The GCP service account to be used for Federated Identity
+    // authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for
+    // the provided role). The `aws_role_arn` must be set up with
+    // `accounts.google.com:sub` equals to this service account number.
+    string gcp_service_account = 5 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // Only one source type can have settings set.
+  oneof source {
+    // Optional. Amazon Kinesis Data Streams.
+    AwsKinesis aws_kinesis = 1 [(google.api.field_behavior) = OPTIONAL];
+  }
 }
 
 // A topic resource.
@@ -179,6 +252,20 @@ message Topic {
     pattern: "_deleted-topic_"
   };
 
+  // The state of the topic.
+  enum State {
+    // Default value. This value is unused.
+    STATE_UNSPECIFIED = 0;
+
+    // The topic does not have any persistent errors.
+    ACTIVE = 1;
+
+    // Ingestion from the data source has encountered a permanent error.
+    // See the more detailed error state in the corresponding ingestion
+    // source configuration.
+    INGESTION_RESOURCE_ERROR = 2;
+  }
+
   // Required. The name of the topic. It must have the format
   // `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
   // and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
@@ -187,37 +274,48 @@ message Topic {
   // must not start with `"goog"`.
   string name = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // See [Creating and managing labels]
+  // Optional. See [Creating and managing labels]
   // (https://cloud.google.com/pubsub/docs/labels).
-  map<string, string> labels = 2;
+  map<string, string> labels = 2 [(google.api.field_behavior) = 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;
+  // 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];
 
-  // The resource name of the Cloud KMS CryptoKey to be used to protect access
-  // to messages published on this topic.
+  // 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;
+  string kms_key_name = 5 [(google.api.field_behavior) = OPTIONAL];
 
-  // Settings for validating messages published against a schema.
-  SchemaSettings schema_settings = 6;
+  // Optional. Settings for validating messages published against a schema.
+  SchemaSettings schema_settings = 6 [(google.api.field_behavior) = 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;
+  // 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];
 
-  // 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
+  // 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.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 managed ingestion from a data source into this
+  // topic.
+  IngestionDataSourceSettings ingestion_data_source_settings = 10
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // A message that is published by publishers and consumed by subscribers. The
@@ -229,14 +327,14 @@ message Topic {
 // (https://cloud.google.com/pubsub/quotas) for more information about message
 // limits.
 message PubsubMessage {
-  // The message data field. If this field is empty, the message must contain
-  // at least one attribute.
-  bytes data = 1;
+  // 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];
 
-  // 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
+  // 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;
+  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
@@ -249,15 +347,15 @@ message PubsubMessage {
   // publisher in a `Publish` call.
   google.protobuf.Timestamp publish_time = 4;
 
-  // 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
+  // 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;
+  string ordering_key = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the GetTopic method.
@@ -299,10 +397,10 @@ message PublishRequest {
 
 // Response for the `Publish` method.
 message PublishResponse {
-  // 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;
+  // 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.
@@ -316,23 +414,23 @@ message ListTopicsRequest {
     }
   ];
 
-  // Maximum number of topics to return.
-  int32 page_size = 2;
+  // Optional. Maximum number of topics to return.
+  int32 page_size = 2 [(google.api.field_behavior) = 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;
+  // 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 {
-  // The resulting topics.
-  repeated Topic topics = 1;
+  // Optional. The resulting topics.
+  repeated Topic topics = 1 [(google.api.field_behavior) = 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;
+  // 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.
@@ -344,26 +442,30 @@ message ListTopicSubscriptionsRequest {
     (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
   ];
 
-  // Maximum number of subscription names to return.
-  int32 page_size = 2;
+  // Optional. Maximum number of subscription names to return.
+  int32 page_size = 2 [(google.api.field_behavior) = 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;
+  // 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 {
-  // The names of subscriptions attached to the topic specified in the request.
-  repeated string subscriptions = 1 [(google.api.resource_reference) = {
-    type: "pubsub.googleapis.com/Subscription"
-  }];
+  // 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"
+    }
+  ];
 
-  // If not empty, indicates that there may be more subscriptions that match
-  // the request; this value should be passed in a new
+  // 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;
+  string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the `ListTopicSnapshots` method.
@@ -375,24 +477,24 @@ message ListTopicSnapshotsRequest {
     (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
   ];
 
-  // Maximum number of snapshot names to return.
-  int32 page_size = 2;
+  // Optional. Maximum number of snapshot names to return.
+  int32 page_size = 2 [(google.api.field_behavior) = 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;
+  // 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 {
-  // The names of the snapshots that match the request.
-  repeated string snapshots = 1;
+  // Optional. The names of the snapshots that match the request.
+  repeated string snapshots = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // If not empty, indicates that there may be more snapshots that match
-  // the request; this value should be passed in a new
+  // 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;
+  string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the `DeleteTopic` method.
@@ -458,8 +560,9 @@ service Subscriber {
     option (google.api.method_signature) = "subscription";
   }
 
-  // Updates an existing subscription. Note that certain properties of a
-  // subscription, such as its topic, are not modifiable.
+  // 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/*}"
@@ -604,7 +707,8 @@ service Subscriber {
     option (google.api.method_signature) = "name,subscription";
   }
 
-  // Updates an existing snapshot. Snapshots are used in
+  // 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
@@ -687,23 +791,24 @@ message Subscription {
     (google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }
   ];
 
-  // If push delivery is used with this subscription, this field is
-  // used to configure it.
-  PushConfig push_config = 4;
-
-  // If delivery to BigQuery is used with this subscription, this field is
+  // Optional. If push delivery is used with this subscription, this field is
   // used to configure it.
-  BigQueryConfig bigquery_config = 18;
+  PushConfig push_config = 4 [(google.api.field_behavior) = OPTIONAL];
 
-  // If delivery to Google Cloud Storage is used with this subscription, this
+  // Optional. If delivery to BigQuery is used with this subscription, this
   // field is used to configure it.
-  CloudStorageConfig cloud_storage_config = 22;
-
-  // 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).
+  BigQueryConfig bigquery_config = 18 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. If delivery to Google Cloud Storage is used with this
+  // subscription, this field is used to configure it.
+  CloudStorageConfig cloud_storage_config = 22
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
+  // waits for the subscriber to acknowledge receipt before resending the
+  // message. In the interval after the message is delivered and before it is
+  // acknowledged, it is considered to be _outstanding_. During that time
+  // period, the message will not be redelivered (on a best-effort basis).
   //
   // For pull subscriptions, this value is used as the initial value for the ack
   // deadline. To override this value for a given message, call
@@ -719,78 +824,81 @@ message Subscription {
   //
   // If the subscriber never acknowledges the message, the Pub/Sub
   // system will eventually redeliver the message.
-  int32 ack_deadline_seconds = 5;
+  int32 ack_deadline_seconds = 5 [(google.api.field_behavior) = OPTIONAL];
 
-  // Indicates whether to retain acknowledged messages. If true, then
+  // 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;
+  bool retain_acked_messages = 7 [(google.api.field_behavior) = OPTIONAL];
 
-  // How long to retain unacknowledged messages in the subscription's backlog,
-  // from the moment a message is published.
-  // If `retain_acked_messages` is true, then this also configures the retention
-  // of acknowledged messages, and thus configures how far back in time a `Seek`
-  // can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
-  // minutes.
-  google.protobuf.Duration message_retention_duration = 8;
+  // Optional. How long to retain unacknowledged messages in the subscription's
+  // backlog, from the moment a message is published. If `retain_acked_messages`
+  // is true, then this also configures the retention of acknowledged messages,
+  // and thus configures how far back in time a `Seek` can be done. Defaults to
+  // 7 days. Cannot be more than 7 days or less than 10 minutes.
+  google.protobuf.Duration message_retention_duration = 8
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // See [Creating and managing
+  // Optional. See [Creating and managing
   // labels](https://cloud.google.com/pubsub/docs/labels).
-  map<string, string> labels = 9;
-
-  // 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;
-
-  // 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
+  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;
+  ExpirationPolicy expiration_policy = 11
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // An expression written in the Pub/Sub [filter
+  // 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;
+  string filter = 12 [(google.api.field_behavior) = 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.
+  // 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 Cloud Pub/Sub service account associated with this subscriptions's
+  // 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;
+  DeadLetterPolicy dead_letter_policy = 13
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // A policy that specifies how Pub/Sub retries message delivery for this
-  // subscription.
+  // Optional. A policy that specifies how Pub/Sub retries message delivery for
+  // this subscription.
   //
   // If not set, the default retry policy is applied. This generally implies
   // that messages will be retried as soon as possible for healthy subscribers.
   // RetryPolicy will be triggered on NACKs or acknowledgement deadline
   // exceeded events for a given message.
-  RetryPolicy retry_policy = 14;
+  RetryPolicy retry_policy = 14 [(google.api.field_behavior) = 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
+  // 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;
+  bool detached = 15 [(google.api.field_behavior) = 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:
+  // Optional. If true, Pub/Sub provides the following guarantees for the
+  // delivery of a message with a given value of `message_id` on this
+  // subscription:
   //
   // * The message sent to a subscriber is guaranteed not to be resent
   // before the message's acknowledgement deadline expires.
@@ -800,7 +908,8 @@ message Subscription {
   // 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;
+  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,
@@ -816,7 +925,7 @@ message Subscription {
   State state = 19 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
-// A policy that specifies how Cloud Pub/Sub retries message delivery.
+// 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.
@@ -828,13 +937,16 @@ message Subscription {
 // between consecutive deliveries may not match the configuration. That is,
 // delay can be more or less than configured backoff.
 message RetryPolicy {
-  // 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;
-
-  // 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;
+  // 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
@@ -843,19 +955,19 @@ message RetryPolicy {
 // If validation on any of the fields fails at subscription creation/updation,
 // the create/update subscription request will fail.
 message DeadLetterPolicy {
-  // The name of the topic to which dead letter messages should be published.
-  // Format is `projects/{project}/topics/{topic}`.The Cloud 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.
+  // 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;
+  string dead_letter_topic = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // The maximum number of delivery attempts for any message. The value must be
-  // between 5 and 100.
+  // Optional. The maximum number of delivery attempts for any message. The
+  // value must be between 5 and 100.
   //
   // The number of delivery attempts is defined as 1 + (the sum of number of
   // NACKs and number of times the acknowledgement deadline has been exceeded
@@ -867,19 +979,19 @@ message DeadLetterPolicy {
   // 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;
+  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 {
-  // 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;
+  // 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.
@@ -888,20 +1000,21 @@ message PushConfig {
   // [OpenID Connect
   // token](https://developers.google.com/identity/protocols/OpenIDConnect).
   message OidcToken {
-    // [Service account
+    // 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;
-
-    // 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;
+    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
@@ -911,18 +1024,18 @@ message PushConfig {
 
   // Sets the `data` field as the HTTP body for delivery.
   message NoWrapper {
-    // When true, writes the Pub/Sub message metadata to
+    // 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;
+    bool write_metadata = 1 [(google.api.field_behavior) = OPTIONAL];
   }
 
-  // A URL locating the endpoint to which messages should be pushed.
+  // 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;
+  string push_endpoint = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // Endpoint configuration attributes that can be used to control different
-  // aspects of the message delivery.
+  // 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
@@ -942,29 +1055,30 @@ message PushConfig {
   //
   // For example:
   // `attributes { "x-goog-version": "v1" }`
-  map<string, string> attributes = 2;
+  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 Cloud Pub/Sub system, for example.
+  // 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 {
-    // 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;
+    // 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 {
-    // When set, the payload to the push endpoint is in the form of the JSON
-    // representation of a PubsubMessage
+    // 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;
+    PubsubWrapper pubsub_wrapper = 4 [(google.api.field_behavior) = OPTIONAL];
 
-    // When set, the payload to the push endpoint is not wrapped.
-    NoWrapper no_wrapper = 5;
+    // Optional. When set, the payload to the push endpoint is not wrapped.
+    NoWrapper no_wrapper = 5 [(google.api.field_behavior) = OPTIONAL];
   }
 }
 
@@ -991,30 +1105,34 @@ message BigQueryConfig {
 
     // 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;
   }
 
-  // The name of the table to which to write data, of the form
+  // Optional. The name of the table to which to write data, of the form
   // {projectId}.{datasetId}.{tableId}
-  string table = 1;
+  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];
 
-  // When true, write the subscription name, message_id, publish_time,
+  // 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;
+  bool write_metadata = 3 [(google.api.field_behavior) = 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
+  // 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;
+  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.
@@ -1036,13 +1154,13 @@ message CloudStorageConfig {
   // Configuration for writing message data in Avro format.
   // Message payloads and metadata will be written to files as an Avro binary.
   message AvroConfig {
-    // 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;
+    // 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];
   }
 
   // Possible states for a Cloud Storage subscription.
@@ -1059,6 +1177,10 @@ message CloudStorageConfig {
 
     // 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;
   }
 
   // Required. User-provided name for the Cloud Storage bucket.
@@ -1067,33 +1189,36 @@ message CloudStorageConfig {
   // requirements] (https://cloud.google.com/storage/docs/buckets#naming).
   string bucket = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // User-provided prefix for Cloud Storage filename. See the [object naming
-  // requirements](https://cloud.google.com/storage/docs/objects#naming).
-  string filename_prefix = 2;
+  // 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];
 
-  // 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;
+  // 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];
 
   // Defaults to text format.
   oneof output_format {
-    // If set, message data will be written to Cloud Storage in text format.
-    TextConfig text_config = 4;
+    // Optional. If set, message data will be written to Cloud Storage in text
+    // format.
+    TextConfig text_config = 4 [(google.api.field_behavior) = OPTIONAL];
 
-    // If set, message data will be written to Cloud Storage in Avro format.
-    AvroConfig avro_config = 5;
+    // Optional. If set, message data will be written to Cloud Storage in Avro
+    // format.
+    AvroConfig avro_config = 5 [(google.api.field_behavior) = 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 acknowledgement deadline.
-  google.protobuf.Duration max_duration = 6;
+  // 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 acknowledgement deadline.
+  google.protobuf.Duration max_duration = 6
+      [(google.api.field_behavior) = 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;
+  // 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];
 
   // Output only. An output-only field that indicates whether or not the
   // subscription can receive messages.
@@ -1102,14 +1227,14 @@ message CloudStorageConfig {
 
 // A message and its corresponding acknowledgment ID.
 message ReceivedMessage {
-  // This ID can be used to acknowledge the received message.
-  string ack_id = 1;
+  // Optional. This ID can be used to acknowledge the received message.
+  string ack_id = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // The message.
-  PubsubMessage message = 2;
+  // Optional. The message.
+  PubsubMessage message = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // The approximate number of times that Cloud Pub/Sub has attempted to deliver
-  // the associated message to a subscriber.
+  // 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.
@@ -1124,7 +1249,7 @@ message ReceivedMessage {
   // 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;
+  int32 delivery_attempt = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the GetSubscription method.
@@ -1161,24 +1286,25 @@ message ListSubscriptionsRequest {
     }
   ];
 
-  // Maximum number of subscriptions to return.
-  int32 page_size = 2;
+  // Optional. Maximum number of subscriptions to return.
+  int32 page_size = 2 [(google.api.field_behavior) = 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;
+  // 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 {
-  // The subscriptions that match the request.
-  repeated Subscription subscriptions = 1;
+  // Optional. The subscriptions that match the request.
+  repeated Subscription subscriptions = 1
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // If not empty, indicates that there may be more subscriptions that match
-  // the request; this value should be passed in a new
+  // 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;
+  string next_page_token = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the DeleteSubscription method.
@@ -1242,12 +1368,13 @@ message PullRequest {
 
 // Response for the `Pull` method.
 message PullResponse {
-  // 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
+  // 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;
+  repeated ReceivedMessage received_messages = 1
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the ModifyAckDeadline method.
@@ -1271,7 +1398,8 @@ message ModifyAckDeadlineRequest {
   // delivery to another subscriber client. This typically results in an
   // increase in the rate of message redeliveries (that is, duplicates).
   // The minimum deadline you can specify is 0 seconds.
-  // The maximum deadline you can specify is 600 seconds (10 minutes).
+  // 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];
 }
 
@@ -1307,14 +1435,15 @@ message StreamingPullRequest {
     }
   ];
 
-  // List of acknowledgement IDs for acknowledging previously received messages
-  // (received on this stream or a different stream). If an ack ID has expired,
-  // the corresponding message may be redelivered later. Acknowledging a message
-  // more than once will not result in an error. If the acknowledgement ID is
-  // malformed, the stream will be aborted with status `INVALID_ARGUMENT`.
-  repeated string ack_ids = 2;
+  // Optional. List of acknowledgement IDs for acknowledging previously received
+  // messages (received on this stream or a different stream). If an ack ID has
+  // expired, the corresponding message may be redelivered later. Acknowledging
+  // a message more than once will not result in an error. If the
+  // acknowledgement ID is malformed, the stream will be aborted with status
+  // `INVALID_ARGUMENT`.
+  repeated string ack_ids = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // The list of new ack deadlines for the IDs listed in
+  // 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
@@ -1325,14 +1454,16 @@ message StreamingPullRequest {
   // 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;
+  repeated int32 modify_deadline_seconds = 3
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // List of acknowledgement IDs whose deadline will be modified based on the
-  // corresponding element in `modify_deadline_seconds`. This field can be used
-  // to indicate that more time is needed to process a message by the
+  // Optional. List of acknowledgement IDs whose deadline will be modified based
+  // on the corresponding element in `modify_deadline_seconds`. This field can
+  // be used to indicate that more time is needed to process a message by the
   // subscriber, or to make the message available for redelivery if the
   // processing was interrupted.
-  repeated string modify_deadline_ack_ids = 4;
+  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
@@ -1341,16 +1472,16 @@ message StreamingPullRequest {
   int32 stream_ack_deadline_seconds = 5
       [(google.api.field_behavior) = REQUIRED];
 
-  // 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
+  // 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;
+  string client_id = 6 [(google.api.field_behavior) = OPTIONAL];
 
-  // Flow control settings for the maximum number of outstanding messages. When
-  // there are `max_outstanding_messages` or more currently sent to the
+  // 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
@@ -1358,18 +1489,18 @@ message StreamingPullRequest {
   // 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;
-
-  // 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
+  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;
+  int64 max_outstanding_bytes = 8 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response for the `StreamingPull` method. This response is used to stream
@@ -1378,56 +1509,69 @@ message StreamingPullResponse {
   // Acknowledgement IDs sent in one or more previous requests to acknowledge a
   // previously received message.
   message AcknowledgeConfirmation {
-    // Successfully processed acknowledgement IDs.
-    repeated string ack_ids = 1;
-
-    // List of acknowledgement IDs that were malformed or whose acknowledgement
-    // deadline has expired.
-    repeated string invalid_ack_ids = 2;
-
-    // List of acknowledgement IDs that were out of order.
-    repeated string unordered_ack_ids = 3;
-
-    // List of acknowledgement IDs that failed processing with temporary issues.
-    repeated string temporary_failed_ack_ids = 4;
+    // Optional. Successfully processed acknowledgement IDs.
+    repeated string ack_ids = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgement IDs that were malformed or whose
+    // acknowledgement deadline has expired.
+    repeated string invalid_ack_ids = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgement IDs that were out of order.
+    repeated string unordered_ack_ids = 3
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgement IDs that failed processing with
+    // temporary issues.
+    repeated string temporary_failed_ack_ids = 4
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Acknowledgement IDs sent in one or more previous requests to modify the
   // deadline for a specific message.
   message ModifyAckDeadlineConfirmation {
-    // Successfully processed acknowledgement IDs.
-    repeated string ack_ids = 1;
-
-    // List of acknowledgement IDs that were malformed or whose acknowledgement
-    // deadline has expired.
-    repeated string invalid_ack_ids = 2;
-
-    // List of acknowledgement IDs that failed processing with temporary issues.
-    repeated string temporary_failed_ack_ids = 3;
+    // Optional. Successfully processed acknowledgement IDs.
+    repeated string ack_ids = 1 [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgement IDs that were malformed or whose
+    // acknowledgement deadline has expired.
+    repeated string invalid_ack_ids = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. List of acknowledgement 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 {
-    // True iff exactly once delivery is enabled for this subscription.
-    bool exactly_once_delivery_enabled = 1;
+    // Optional. True iff exactly once delivery is enabled for this
+    // subscription.
+    bool exactly_once_delivery_enabled = 1
+        [(google.api.field_behavior) = OPTIONAL];
 
-    // True iff message ordering is enabled for this subscription.
-    bool message_ordering_enabled = 2;
+    // Optional. True iff message ordering is enabled for this subscription.
+    bool message_ordering_enabled = 2 [(google.api.field_behavior) = OPTIONAL];
   }
 
-  // Received Pub/Sub messages. This will not be empty.
-  repeated ReceivedMessage received_messages = 1;
+  // Optional. Received Pub/Sub messages. This will not be empty.
+  repeated ReceivedMessage received_messages = 1
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // This field will only be set if `enable_exactly_once_delivery` is set to
-  // `true`.
-  AcknowledgeConfirmation acknowledge_confirmation = 5;
+  // Optional. This field will only be set if `enable_exactly_once_delivery` is
+  // set to `true`.
+  AcknowledgeConfirmation acknowledge_confirmation = 5
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // This field will only be set if `enable_exactly_once_delivery` is set to
-  // `true`.
-  ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3;
+  // Optional. This field will only be set if `enable_exactly_once_delivery` is
+  // set to `true`.
+  ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // Properties associated with this subscription.
-  SubscriptionProperties subscription_properties = 4;
+  // Optional. Properties associated with this subscription.
+  SubscriptionProperties subscription_properties = 4
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the `CreateSnapshot` method.
@@ -1459,9 +1603,9 @@ message CreateSnapshotRequest {
     }
   ];
 
-  // See [Creating and managing
+  // Optional. See [Creating and managing
   // labels](https://cloud.google.com/pubsub/docs/labels).
-  map<string, string> labels = 3;
+  map<string, string> labels = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the UpdateSnapshot method.
@@ -1486,15 +1630,17 @@ message Snapshot {
     pattern: "projects/{project}/snapshots/{snapshot}"
   };
 
-  // The name of the snapshot.
-  string name = 1;
+  // Optional. The name of the snapshot.
+  string name = 1 [(google.api.field_behavior) = OPTIONAL];
 
-  // The name of the topic from which this snapshot is retaining messages.
+  // 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" }
   ];
 
-  // The snapshot is guaranteed to exist up until this time.
+  // 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
@@ -1504,11 +1650,12 @@ message Snapshot {
   // 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.protobuf.Timestamp expire_time = 3
+      [(google.api.field_behavior) = OPTIONAL];
 
-  // See [Creating and managing labels]
+  // Optional. See [Creating and managing labels]
   // (https://cloud.google.com/pubsub/docs/labels).
-  map<string, string> labels = 4;
+  map<string, string> labels = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for the GetSnapshot method.
@@ -1532,23 +1679,24 @@ message ListSnapshotsRequest {
     }
   ];
 
-  // Maximum number of snapshots to return.
-  int32 page_size = 2;
+  // Optional. Maximum number of snapshots to return.
+  int32 page_size = 2 [(google.api.field_behavior) = 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;
+  // 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 {
-  // The resulting snapshots.
-  repeated Snapshot snapshots = 1;
+  // Optional. The resulting snapshots.
+  repeated Snapshot snapshots = 1 [(google.api.field_behavior) = 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;
+  // 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.
@@ -1572,7 +1720,7 @@ message SeekRequest {
   ];
 
   oneof target {
-    // The time to seek to.
+    // 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
@@ -1583,14 +1731,17 @@ message SeekRequest {
     // 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;
-
-    // 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.resource_reference) = {
-      type: "pubsub.googleapis.com/Snapshot"
-    }];
+    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"
+      }
+    ];
   }
 }