Class: Google::Apis::PubsubV1beta1a::PubsubMessage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/pubsub_v1beta1a/classes.rb,
generated/google/apis/pubsub_v1beta1a/representations.rb,
generated/google/apis/pubsub_v1beta1a/representations.rb

Overview

A message data and its labels.

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



384
385
386
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 384

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

Instance Attribute Details

#data ⇒ String

The message payload. Corresponds to the JSON property data NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


362
363
364
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 362

def data
  @data
end

#label ⇒ Array<Google::Apis::PubsubV1beta1a::Label>

Optional list of labels for this message. Keys in this collection must be unique. Corresponds to the JSON property label

Returns:



368
369
370
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 368

def label
  @label
end

#message_id ⇒ String

ID of this message assigned by the server at publication time. 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 a publisher in a Publish call. Corresponds to the JSON property messageId

Returns:

  • (String) 


376
377
378
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 376

def message_id
  @message_id
end

#publish_time ⇒ Fixnum

The time at which the message was published. The time is milliseconds since the UNIX epoch. Corresponds to the JSON property publishTime

Returns:

  • (Fixnum) 


382
383
384
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 382

def publish_time
  @publish_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



389
390
391
392
393
394
 
# File 'generated/google/apis/pubsub_v1beta1a/classes.rb', line 389

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