fix(pubsub): mark ignore option default for publish flow control (#5983)

googleapis · May 4, 2022 · 3f41531 · 3f41531
1 parent 3972c38
commit 3f41531
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/pubsub/flow_controller.go b/pubsub/flow_controller.go
@@ -27,10 +27,10 @@ import (
 type LimitExceededBehavior int
 
 const (
-	// FlowControlBlock signals to wait until the request can be made without exceeding the limit.
-	FlowControlBlock LimitExceededBehavior = iota
 	// FlowControlIgnore disables flow control.
-	FlowControlIgnore
+	FlowControlIgnore LimitExceededBehavior = iota
+	// FlowControlBlock signals to wait until the request can be made without exceeding the limit.
+	FlowControlBlock
 	// FlowControlSignalError signals an error to the caller of acquire.
 	FlowControlSignalError
 )
@@ -47,7 +47,7 @@ type FlowControlSettings struct {
 
 	// LimitExceededBehavior configures the behavior when trying to publish
 	// additional messages while the flow controller is full. The available options
-	// include Block (default), Ignore (disable), and SignalError (publish
+	// are Ignore (disable, default), Block, and SignalError (publish
 	// results will return an error).
 	LimitExceededBehavior LimitExceededBehavior
 }

diff --git a/pubsub/topic.go b/pubsub/topic.go
@@ -105,7 +105,7 @@ type PublishSettings struct {
 	// If MaxOutstandingBytes is set, that value will override BufferedByteLimit.
 	//
 	// Defaults to DefaultPublishSettings.BufferedByteLimit.
-	// Deprecated: Set `topic.PublishSettings.FlowControlSettings.MaxOutstandingBytes` instead.
+	// Deprecated: Set `Topic.PublishSettings.FlowControlSettings.MaxOutstandingBytes` instead.
 	BufferedByteLimit int
 
 	// FlowControlSettings defines publisher flow control settings.
@@ -628,9 +628,7 @@ func (t *Topic) initBundler() {
 	t.scheduler.BundleByteThreshold = t.PublishSettings.ByteThreshold
 
 	fcs := DefaultPublishSettings.FlowControlSettings
-	if t.PublishSettings.FlowControlSettings.LimitExceededBehavior != FlowControlBlock {
-		fcs.LimitExceededBehavior = t.PublishSettings.FlowControlSettings.LimitExceededBehavior
-	}
+	fcs.LimitExceededBehavior = t.PublishSettings.FlowControlSettings.LimitExceededBehavior
 	if t.PublishSettings.FlowControlSettings.MaxOutstandingBytes > 0 {
 		b := t.PublishSettings.FlowControlSettings.MaxOutstandingBytes
 		fcs.MaxOutstandingBytes = b