fix(regen): deprecate return_immediately

google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/SubscriptionAdminClient.java

@@ -1071,10 +1071,12 @@ public final UnaryCallable<DeleteSubscriptionRequest, Empty> deleteSubscriptionC
    *
    * @param subscription Required. The subscription from which messages should be pulled. Format is
    *     `projects/{project}/subscriptions/{sub}`.
-   * @param returnImmediately 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.
+   * @param returnImmediately 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.
    * @param maxMessages 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.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -1108,10 +1110,12 @@ public final UnaryCallable<DeleteSubscriptionRequest, Empty> deleteSubscriptionC
    *
    * @param subscription Required. The subscription from which messages should be pulled. Format is
    *     `projects/{project}/subscriptions/{sub}`.
-   * @param returnImmediately 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.
+   * @param returnImmediately 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.
    * @param maxMessages 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.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails

proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/AcknowledgeRequest.java

@@ -185,8 +185,9 @@ public com.google.protobuf.ByteString getSubscriptionBytes() {
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -200,8 +201,9 @@ public com.google.protobuf.ProtocolStringList getAckIdsList() {
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -215,8 +217,9 @@ public int getAckIdsCount() {
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -231,8 +234,9 @@ public java.lang.String getAckIds(int index) {
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -729,8 +733,9 @@ private void ensureAckIdsIsMutable() {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -744,8 +749,9 @@ public com.google.protobuf.ProtocolStringList getAckIdsList() {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -759,8 +765,9 @@ public int getAckIdsCount() {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -775,8 +782,9 @@ public java.lang.String getAckIds(int index) {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -791,8 +799,9 @@ public com.google.protobuf.ByteString getAckIdsBytes(int index) {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -814,8 +823,9 @@ public Builder setAckIds(int index, java.lang.String value) {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -836,8 +846,9 @@ public Builder addAckIds(java.lang.String value) {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -855,8 +866,9 @@ public Builder addAllAckIds(java.lang.Iterable<java.lang.String> values) {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -873,8 +885,9 @@ public Builder clearAckIds() {
      *
      *
      * <pre>
-     * 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.
+     * 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.
      * </pre>
      *
      * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>

proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/AcknowledgeRequestOrBuilder.java

@@ -58,8 +58,9 @@ public interface AcknowledgeRequestOrBuilder
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -71,8 +72,9 @@ public interface AcknowledgeRequestOrBuilder
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -84,8 +86,9 @@ public interface AcknowledgeRequestOrBuilder
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@@ -98,8 +101,9 @@ public interface AcknowledgeRequestOrBuilder
    *
    *
    * <pre>
-   * 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.
+   * 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.
    * </pre>
    *
    * <code>repeated string ack_ids = 2 [(.google.api.field_behavior) = REQUIRED];</code>

proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CreateSnapshotRequest.java

@@ -150,10 +150,10 @@ protected com.google.protobuf.MapField internalGetMapField(int number) {
    *
    *
    * <pre>
-   * 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 &lt;a
+   * 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 &lt;a
    * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
    * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
    * </pre>
@@ -179,10 +179,10 @@ public java.lang.String getName() {
    *
    *
    * <pre>
-   * 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 &lt;a
+   * 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 &lt;a
    * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
    * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
    * </pre>
@@ -750,10 +750,10 @@ public Builder mergeFrom(
      *
      *
      * <pre>
-     * 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 &lt;a
+     * 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 &lt;a
      * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
      * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
      * </pre>
@@ -779,10 +779,10 @@ public java.lang.String getName() {
      *
      *
      * <pre>
-     * 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 &lt;a
+     * 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 &lt;a
      * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
      * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
      * </pre>
@@ -808,10 +808,10 @@ public com.google.protobuf.ByteString getNameBytes() {
      *
      *
      * <pre>
-     * 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 &lt;a
+     * 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 &lt;a
      * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
      * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
      * </pre>
@@ -836,10 +836,10 @@ public Builder setName(java.lang.String value) {
      *
      *
      * <pre>
-     * 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 &lt;a
+     * 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 &lt;a
      * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
      * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
      * </pre>
@@ -860,10 +860,10 @@ public Builder clearName() {
      *
      *
      * <pre>
-     * 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 &lt;a
+     * 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 &lt;a
      * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
      * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
      * </pre>

proto-google-cloud-pubsub-v1/src/main/java/com/google/pubsub/v1/CreateSnapshotRequestOrBuilder.java

@@ -27,10 +27,10 @@ public interface CreateSnapshotRequestOrBuilder
    *
    *
    * <pre>
-   * 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 &lt;a
+   * 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 &lt;a
    * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
    * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
    * </pre>
@@ -46,10 +46,10 @@ public interface CreateSnapshotRequestOrBuilder
    *
    *
    * <pre>
-   * 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 &lt;a
+   * 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 &lt;a
    * href="https://cloud.google.com/pubsub/docs/admin#resource_names"&gt; resource
    * name rules&lt;/a&gt;. Format is `projects/{project}/snapshots/{snap}`.
    * </pre>