Class: Google::Apis::PubsubV1beta2::PubsubMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
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::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PubsubMessage

Returns a new instance of PubsubMessage



443
444
445
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 443

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

Instance Attribute Details

#attributes ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


419
420
421
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 419

def attributes
  @attributes
end

#data ⇒ String

The message payload. For JSON requests, the value of this field must be base64-encoded. Corresponds to the JSON property data NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


426
427
428
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 426

def data
  @data
end

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

Returns:

  • (String) 


434
435
436
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 434

def message_id
  @message_id
end

#publish_time ⇒ String

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) 


441
442
443
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 441

def publish_time
  @publish_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



448
449
450
451
452
453
 
# File 'generated/google/apis/pubsub_v1beta2/classes.rb', line 448

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