Skip to content

PublishOptions

Defined in: packages/pubsub/src/types.ts:27

Options for publishing a protobuf event as a CloudEvent.

CloudEvents specification

optional id?: string

Defined in: packages/pubsub/src/types.ts:35

CloudEvent id. Defaults to a generated UUID.


optional metadata?: Record<string, CloudEventMetadataValue>

Defined in: packages/pubsub/src/types.ts:39

Additional CloudEvent extension attributes.


optional notBefore?: Timestamp

Defined in: packages/pubsub/src/types.ts:48

Durable one-shot delayed delivery deadline.

Production transports must persist the delay before accepting the publish and must not deliver before this timestamp.

google.protobuf.Timestamp


optional source?: string

Defined in: packages/pubsub/src/types.ts:33

CloudEvent source for this publish call. Overrides publisher and transport defaults.


optional time?: string | Date

Defined in: packages/pubsub/src/types.ts:37

CloudEvent time. Defaults to the current time.


optional topic?: string

Defined in: packages/pubsub/src/types.ts:29

Transport delivery topic. Overrides publisher topic defaults for this call only.


optional type?: string

Defined in: packages/pubsub/src/types.ts:31

Semantic CloudEvent type. Defaults to the fully qualified protobuf method name.