pubsub

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package pubsub provides structures for publishing messages to topics and managing topic attributes in a messaging system.

Package pubsub provides structures for managing messages and topics within a publish-subscribe messaging system.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetTopicAttributesInput

type GetTopicAttributesInput struct {
	TopicId string // TopicId identifies the topic for which attributes are being retrieved.
}

GetTopicAttributesInput contains the parameters for retrieving attributes of a specific topic. This structure is typically used in administrative tasks such as monitoring and configuring topics.

type GetTopicAttributesResult

type GetTopicAttributesResult struct {
	Attributes map[string]string // Attributes is a map where each key-value pair represents the name and value of an attribute of the topic.
}

GetTopicAttributesResult holds the results of a request to retrieve attributes for a specific topic. It contains a map of attribute names to their corresponding values, detailing various properties of the topic.

type PublishInput

type PublishInput struct {
	Message           string            // Message is the content of the message to be published.
	TopicId           string            // TopicId identifies the topic to which the message will be published.
	MessageGroupId    string            // MessageGroupId is an identifier used for message grouping in the target topic (useful in ordered delivery scenarios).
	MessageDedupeId   string            // MessageDedupeId is an identifier for message deduplication. This prevents publishing duplicate messages within a certain time frame.
	MessageAttributes map[string]string // MessageAttributes are string attributes used for SNS subscription filtering and routing.
	DeviceEndpointId  string            // DeviceEndpointId identifies a specific device endpoint for targeted message delivery.
	PhoneNumber       string            // PhoneNumber is used when the message needs to be sent to a specific phone number.
	Subject           string            // Subject is a brief description or summary of the message content.
}

PublishInput contains the parameters required for publishing a message to a specific topic. It includes various identifiers that can control message routing and delivery properties, such as deduplication and targeting specific devices or phone numbers.

type PublishResult

type PublishResult struct {
	MessageId string // MessageId is the unique identifier assigned to the successfully published message.
}

PublishResult contains the result of a message publish operation to a topic. It primarily includes the unique identifier of the message once it has been successfully published.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL