v1 Publish messages with flow control settings (DEPRECATED)
Stay organized with collections
Save and categorize content based on your preferences.
(DEPRECATED) Publish messages with flow control settings
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[],[],null,["# v1 Publish messages with flow control settings (DEPRECATED)\n\n(DEPRECATED) Publish messages with flow control settings\n\nCode sample\n-----------\n\n### Go\n\n\nBefore trying this sample, follow the Go setup instructions in the\n[Pub/Sub quickstart using\nclient libraries](/pubsub/docs/quickstart-client-libraries).\n\n\nFor more information, see the\n[Pub/Sub Go API\nreference documentation](https://godoc.org/cloud.google.com/go/pubsub).\n\n\nTo authenticate to Pub/Sub, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n import (\n \t\"context\"\n \t\"fmt\"\n \t\"io\"\n \t\"strconv\"\n \t\"sync\"\n \t\"sync/atomic\"\n\n \t\"cloud.google.com/go/pubsub\"\n )\n\n func publishWithFlowControlSettings(w io.Writer, projectID, topicID string) error {\n \t// projectID := \"my-project-id\"\n \t// topicID := \"my-topic\"\n \tctx := context.Background()\n \tclient, err := pubsub.https://cloud.google.com/go/docs/reference/cloud.google.com/go/pubsub/latest/index.html#cloud_google_com_go_pubsub_Client_NewClient(ctx, projectID)\n \tif err != nil {\n \t\treturn fmt.Errorf(\"pubsub.NewClient: %w\", err)\n \t}\n \tdefer client.Close()\n\n \tt := client.Topic(topicID)\n \tt.PublishSettings.https://cloud.google.com/go/docs/reference/cloud.google.com/go/pubsub/latest/index.html#cloud_google_com_go_pubsub_FlowControlSettings = pubsub.https://cloud.google.com/go/docs/reference/cloud.google.com/go/pubsub/latest/index.html#cloud_google_com_go_pubsub_FlowControlSettings{\n \t\tMaxOutstandingMessages: 100, // default 1000\n \t\tMaxOutstandingBytes: 10 * 1024 * 1024, // default 0 (unlimited)\n \t\tLimitExceededBehavior: pubsub.https://cloud.google.com/go/docs/reference/cloud.google.com/go/pubsub/latest/index.html#cloud_google_com_go_pubsub_FlowControlIgnore_FlowControlBlock_FlowControlSignalError, // default Ignore, other options: Block and SignalError\n \t}\n\n \tvar wg sync.WaitGroup\n \tvar totalErrors uint64\n\n \tnumMsgs := 1000\n \t// Rapidly publishing 1000 messages in a loop may be constrained by flow control.\n \tfor i := 0; i \u003c numMsgs; i++ {\n \t\twg.Add(1)\n \t\tresult := t.Publish(ctx, &pubsub.Message{\n \t\t\tData: []byte(\"message #\" + strconv.Itoa(i)),\n \t\t})\n \t\tgo func(i int, res *pubsub.https://cloud.google.com/go/docs/reference/cloud.google.com/go/pubsub/latest/index.html#cloud_google_com_go_pubsub_PublishResult) {\n \t\t\tfmt.Fprintf(w, \"Publishing message %d\\n\", i)\n \t\t\tdefer wg.Done()\n \t\t\t// The Get method blocks until a server-generated ID or\n \t\t\t// an error is returned for the published message.\n \t\t\t_, err := res.Get(ctx)\n \t\t\tif err != nil {\n \t\t\t\t// Error handling code can be added here.\n \t\t\t\tfmt.Fprintf(w, \"Failed to publish: %v\", err)\n \t\t\t\tatomic.AddUint64(&totalErrors, 1)\n \t\t\t\treturn\n \t\t\t}\n \t\t}(i, result)\n \t}\n\n \twg.Wait()\n\n \tif totalErrors \u003e 0 {\n \t\treturn fmt.Errorf(\"%d of %d messages did not publish successfully\", totalErrors, numMsgs)\n \t}\n \treturn nil\n }\n\n### Ruby\n\n\nBefore trying this sample, follow the Ruby setup instructions in the\n[Pub/Sub quickstart using\nclient libraries](/pubsub/docs/quickstart-client-libraries).\n\n\nFor more information, see the\n[Pub/Sub Ruby API\nreference documentation](https://googleapis.dev/ruby/google-cloud-pubsub/latest/Google/Cloud/PubSub.html).\n\n\nTo authenticate to Pub/Sub, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n # topic_id = \"your-topic-id\"\n\n pubsub = Google::Cloud::https://cloud.google.com/ruby/docs/reference/google-cloud-pubsub/latest/Google-Cloud.html.new\n\n topic = pubsub.topic topic_id, async: {\n # Configure how many messages the publisher client can hold in memory\n # and what to do when messages exceed the limit.\n flow_control: {\n message_limit: 100,\n byte_limit: 10 * 1024 * 1024, # 10 MiB\n # Block more messages from being published when the limit is reached. The\n # other options are :ignore and :error.\n limit_exceeded_behavior: :block\n }\n }\n # Rapidly publishing 1000 messages in a loop may be constrained by flow control.\n 1000.times do |i|\n topic.publish_async \"message #{i}\" do |result|\n raise \"Failed to publish the message.\" unless result.succeeded?\n end\n end\n\n # Stop the async_publisher to send all queued messages immediately.\n topic.async_publisher.stop.wait!\n puts \"Published messages with flow control settings to #{topic_id}.\"\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=pubsub)."]]