pubsub

Documentation

Overview

Package pubsub contains utilities for handling Google Cloud Pub/Sub events.

Index

• func ExtractTopicFromRequestPath(path string) (string, error)
• type LegacyPushSubscriptionEvent
  • func (e *LegacyPushSubscriptionEvent) ToBackgroundEvent(topic string) *fftypes.BackgroundEvent
• type Message

Functions

func ExtractTopicFromRequestPath

func ExtractTopicFromRequestPath(path string) (string, error)

ExtractTopicFromRequestPath extracts a Pub/Sub topic from a URL request path.

Types

type LegacyPushSubscriptionEvent

type LegacyPushSubscriptionEvent struct {
	Subscription string `json:"subscription"`
	Message      `json:"message"`
}

LegacyPushSubscriptionEvent is the event payload for legacy Cloud Pub/Sub push subscription triggers (https://cloud.google.com/functions/docs/calling/pubsub#legacy_cloud_pubsub_triggers). This matched the event payload that is sent by Pub/Sub to HTTP push subscription endpoints (https://cloud.google.com/pubsub/docs/push#receiving_messages).

func (*LegacyPushSubscriptionEvent) ToBackgroundEvent

func (e *LegacyPushSubscriptionEvent) ToBackgroundEvent(topic string) *fftypes.BackgroundEvent

ToBackgroundEvent converts the event to the standard BackgroundEvent format for Background Functions.

type Message

type Message struct {
	pubsub.Message
	// The pubsub libary's Message.Id field (https://pkg.go.dev/cloud.google.com/go/internal/pubsub#Message)
	// doesn't have the correct JSON tag (it serializes to "id" instead of
	// "messageId"), so use this field to capture the JSON field with key
	// "messageId".
	IdFromJSON string `json:"messageId"`
}

Message is a pubsub.Message but with the correct JSON tag for the message ID field that matches https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage