Skip to content

BuildCloudEventOptions

Defined in: packages/pubsub/src/cloudevents.ts:34

Fully-resolved options required to materialize a CloudEvent.

CloudEvents specification

optional id?: string

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

CloudEvent id. Defaults to a generated UUID.

PublishOptions.id


optional metadata?: Record<string, CloudEventMetadataValue>

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

Additional CloudEvent extension attributes.

PublishOptions.metadata


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

PublishOptions.notBefore


source: string

Defined in: packages/pubsub/src/cloudevents.ts:36

Resolved CloudEvent source.

PublishOptions.source


optional time?: string | Date

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

CloudEvent time. Defaults to the current time.

PublishOptions.time


optional topic?: string

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

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

PublishOptions.topic


type: string

Defined in: packages/pubsub/src/cloudevents.ts:38

Resolved CloudEvent type.

PublishOptions.type