Class: Google::Apis::PubsubV1::Message
- Inherits:
-
Object
- Object
- Google::Apis::PubsubV1::Message
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/pubsub_v1/classes.rb,
generated/google/apis/pubsub_v1/representations.rb,
generated/google/apis/pubsub_v1/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
-
#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 ⇒ String
The time at which the message was published, populated by the server when it receives the
Publish
call.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Message
constructor
A new instance of Message.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Message
Returns a new instance of Message.
252 253 254 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 252 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ Hash<String,String>
Optional attributes for this message.
Corresponds to the JSON property attributes
235 236 237 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 235 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
230 231 232 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 230 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
243 244 245 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 243 def @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
250 251 252 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 250 def publish_time @publish_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
257 258 259 260 261 262 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 257 def update!(**args) @data = args[:data] if args.key?(:data) @attributes = args[:attributes] if args.key?(:attributes) @message_id = args[:message_id] if args.key?(:message_id) @publish_time = args[:publish_time] if args.key?(:publish_time) end |