googlepubsub

Google Cloud Pub/Sub Bindings

This document defines how to describe Google Cloud Pub/Sub specific information with AsyncAPI.

Version

Current version is 0.2.0.

Channel Binding Object

The Channel Bindings Object is used to describe the Google Cloud Pub/Sub specific Topic details with AsyncAPI.

Field Name	Type	Description
bindingVersion	String	The current version is 0.2.0
labels	Object	An object of key-value pairs (These are used to categorize Cloud Resources like Cloud Pub/Sub Topics.)
messageRetentionDuration	String	Indicates the minimum duration to retain a message after it is published to the topic (Must be a valid Duration.)
messageStoragePolicy	Message Storage Policy Object	Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored
schemaSettings	Schema Settings Object	Settings for validating messages published against a schema

Message Storage Policy Object

The Message Storage Policy Object is used to describe the Google Cloud Pub/Sub MessageStoragePolicy Object with AsyncAPI.

Field Name	Type	Description
allowedPersistenceRegions	String[]	A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage

Schema Settings Object

The Schema Settings Object is used to describe the Google Cloud Pub/Sub SchemaSettings Object with AsyncAPI.

Field Name	Type	Description
encoding	String	The encoding of the message (Must be one of the possible Encoding values.)
firstRevisionId	String	The minimum (inclusive) revision allowed for validating messages
lastRevisionId	String	The maximum (inclusive) revision allowed for validating messages
name	String	The name of the schema that messages published should be validated against (The format is projects/{project}/schemas/{schema}.)

Example

# ...
channels:
  topic-avro-schema:
    address: projects/your-project/topics/topic-avro-schema
    bindings:
      googlepubsub:
        schemaSettings:
          encoding: json
          name: projects/your-project/schemas/message-avro
# ...
  topic-proto-schema:
    address: projects/your-project/topics/topic-proto-schema
    bindings:
      googlepubsub:
        messageRetentionDuration: 86400s
        messageStoragePolicy:
          allowedPersistenceRegions:
          - us-central1
          - us-central2
          - us-east1
          - us-east4
          - us-east5
          - us-east7
          - us-south1
          - us-west1
          - us-west2
          - us-west3
          - us-west4
        schemaSettings:
          encoding: binary
          name: projects/your-project/schemas/message-proto
# ...

Message Binding Object

The Message Binding Object is used to describe the Google Cloud Pub/Sub specific PubsubMessage details, alongside with pertintent parts of the Google Cloud Pub/Sub Schema Object, with AsyncAPI.

Field Name	Type	Description
bindingVersion	String	The current version is 0.2.0
attributes	Object	Attributes for this message (If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription.)
orderingKey	String	If non-empty, identifies related messages for which publish order should be respected (For more information, see ordering messages.)
schema	Schema Definition Object	Describes the schema used to validate the payload of this message

Schema Definition Object

The Schema Definition Object is used to describe the Google Cloud Pub/Sub Schema Object with AsyncAPI. While some of this information could be, or is, described using native AsyncAPI, for consistency it makes sense to provide this information here at all times, especially for cases where AsyncAPI does not natively support describing payloads using a supported Google Cloud Pub/Sub schema format like Protobuf.

Field Name	Type	Description
name	String	The name of the schema

Example

# ...
components:
  messages:
    messageAvro:
      bindings:
        googlepubsub:
          schema:
            name: projects/your-project/schemas/message-avro
      contentType: application/json
      name: MessageAvro
      payload:
        schema:
          fields:
          - name: message
            type: string
          name: Message
          type: record
        schemaFormat: application/vnd.apache.avro+yaml;version=1.9.0
    messageProto:
      bindings:
        googlepubsub:
          schema:
            name: projects/your-project/schemas/message-proto
      contentType: application/octet-stream
      name: MessageProto
      payload:
        schema: |
          syntax = "proto3";

          message Message {
            required string message = 1;
          }
        schemaFormat: application/vnd.google.protobuf;version=3
# ...

Operation Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Server Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.