Class: Google::Apis::PubsubV1beta2::Message

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/pubsub_v1beta2/classes.rb,
generated/google/apis/pubsub_v1beta2/representations.rb,
generated/google/apis/pubsub_v1beta2/representations.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 collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.


244
245
246
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 244

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attributesHash<String,String>

Optional attributes for this message. Corresponds to the JSON property attributes

Returns:

  • (Hash<String,String>)

227
228
229
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 227

def attributes
  @attributes
end

#dataString

The message payload. For JSON requests, the value of this field must be base64- encoded. Corresponds to the JSON property data

Returns:

  • (String)

222
223
224
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 222

def data
  @data
end

#message_idString

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. Corresponds to the JSON property messageId

Returns:

  • (String)

235
236
237
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 235

def message_id
  @message_id
end

#publish_timeString

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. Corresponds to the JSON property publishTime

Returns:

  • (String)

242
243
244
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 242

def publish_time
  @publish_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


249
250
251
252
253
254
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 249

def update!(**args)
  @data = args[:data] unless args[:data].nil?
  @attributes = args[:attributes] unless args[:attributes].nil?
  @message_id = args[:message_id] unless args[:message_id].nil?
  @publish_time = args[:publish_time] unless args[:publish_time].nil?
end