PubsubMessage

google.pubsub.v1. PubsubMessage

Represents a PubsubMessage.

Constructor

new PubsubMessage(propertiesopt)

Constructs a new PubsubMessage.

Parameters:
Name Type Attributes Description
properties google.pubsub.v1.IPubsubMessage <optional>

Properties to set

Implements:
  • IPubsubMessage

Members

attributes :Object.<string, string>

PubsubMessage attributes.

data :Uint8Array

PubsubMessage data.

messageId :string

PubsubMessage messageId.

orderingKey :string

PubsubMessage orderingKey.

publishTime :google.protobuf.ITimestamp|null|undefined

PubsubMessage publishTime.

Methods

(static) create(propertiesopt) → {google.pubsub.v1.PubsubMessage}

Creates a new PubsubMessage instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.pubsub.v1.IPubsubMessage <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.pubsub.v1.PubsubMessage}

Decodes a PubsubMessage message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.pubsub.v1.PubsubMessage}

Decodes a PubsubMessage message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PubsubMessage message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.pubsub.v1.IPubsubMessage

PubsubMessage message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified PubsubMessage message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.pubsub.v1.IPubsubMessage

PubsubMessage message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.pubsub.v1.PubsubMessage}

Creates a PubsubMessage message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a PubsubMessage message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.pubsub.v1.PubsubMessage

PubsubMessage

options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a PubsubMessage message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this PubsubMessage to JSON.