Skip to content

Pub/Sub: document regional endpoint#8789

Merged
anguillanneuf merged 2 commits into
masterfrom
regional_endpoints
Jul 26, 2019
Merged

Pub/Sub: document regional endpoint#8789
anguillanneuf merged 2 commits into
masterfrom
regional_endpoints

Conversation

@anguillanneuf

@anguillanneuf anguillanneuf commented Jul 25, 2019

Copy link
Copy Markdown
Contributor

Please comment if this is enough documentation for showing how to configure regional endpoint.

I could take this opportunity to document other kwargs if needed, but it's recommended that users don't touch those.

@anguillanneuf anguillanneuf requested a review from plamut as a code owner July 25, 2019 23:05
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 25, 2019

@plamut plamut left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please comment on if this is enough documentation on regional endpoint re configuring it.
Depends on who reported this, what level of detail is expected?

In a vacuum, the addition looks fine to me. Perhaps just make it a tad more clear with an example?

... single key-value pair of name `api_endpoint`, e.g. `client_options={"api_endpoint": REGIONAL_ENDPOINT}`

@tseaver tseaver added api: pubsub Issues related to the Pub/Sub API. type: docs Improvement to the documentation for an API. labels Jul 26, 2019

@plamut plamut left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@anguillanneuf anguillanneuf merged commit 03aabdd into master Jul 26, 2019
@anguillanneuf anguillanneuf deleted the regional_endpoints branch July 26, 2019 17:23
parthea pushed a commit that referenced this pull request Mar 2, 2026
* document client_options

* show an example that sets client_options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: pubsub Issues related to the Pub/Sub API. cla: yes This human has signed the Contributor License Agreement. type: docs Improvement to the documentation for an API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants