Class: Google::Pubsub::V1::PubsubMessage

Inherits:

Object

• Object
• Google::Pubsub::V1::PubsubMessage

Defined in:

lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

Instance Attribute Summary

• #attributes ⇒ Hash{String => String}

  Optional attributes for this message.

• #data ⇒ String

  The message payload.

• #message_id ⇒ String

  ID of this message, assigned by the server when the message is published.

• #publish_time ⇒ Google::Protobuf::Timestamp

  The time at which the message was published, populated by the server when it receives the +Publish+ call.

Instance Attribute Details

#attributes ⇒ Hash{String => String}

Returns Optional attributes for this message.

Returns:

• (Hash{String => String}) —

  Optional attributes for this message.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 70

class PubsubMessage; end

#data ⇒ String

Returns The message payload.

Returns:

• (String) —

  The message payload.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 70

class PubsubMessage; end

#message_id ⇒ String

Returns ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a +PubsubMessage+ via a +Pull+ call or a push delivery. It must not be populated by the publisher in a +Publish+ call.

Returns:

• (String) —

  ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a +PubsubMessage+ via a +Pull+ call or a push delivery. It must not be populated by the publisher in a +Publish+ call.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 70

class PubsubMessage; end

#publish_time ⇒ Google::Protobuf::Timestamp

Returns The time at which the message was published, populated by the server when it receives the +Publish+ call. It must not be populated by the publisher in a +Publish+ call.

Returns:

• (Google::Protobuf::Timestamp) —

  The time at which the message was published, populated by the server when it receives the +Publish+ call. It must not be populated by the publisher in a +Publish+ call.

# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 70

class PubsubMessage; end