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 that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding client library documentation for more information. See Quotas and limits for more information about message limits.
Instance Attribute Summary collapse
-
#attributes ⇒ Hash<String,String>
Attributes for this message.
-
#data ⇒ String
The message data field.
-
#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.
748 749 750 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 748 def initialize(**args) update!(**args) end |
Instance Attribute Details
#attributes ⇒ Hash<String,String>
Attributes for this message. If this field is empty, the message must
contain non-empty data.
Corresponds to the JSON property attributes
724 725 726 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 724 def attributes @attributes end |
#data ⇒ String
The message data field. If this field is empty, the message must contain
at least one attribute.
Corresponds to the JSON property data
NOTE: Values are automatically base64 encoded/decoded in the client library.
731 732 733 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 731 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
739 740 741 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 739 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
746 747 748 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 746 def publish_time @publish_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
753 754 755 756 757 758 |
# File 'generated/google/apis/pubsub_v1/classes.rb', line 753 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 |