Class: Google::Apis::CloudschedulerV1::PubsubMessage
- Inherits:
-
Object
- Object
- Google::Apis::CloudschedulerV1::PubsubMessage
- Defined in:
- generated/google/apis/cloudscheduler_v1/classes.rb,
generated/google/apis/cloudscheduler_v1/representations.rb,
generated/google/apis/cloudscheduler_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) ⇒ PubsubMessage
constructor
A new instance of PubsubMessage.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ PubsubMessage
Returns a new instance of PubsubMessage.
725 726 727 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 725 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
701 702 703 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 701 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.
708 709 710 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 708 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
716 717 718 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 716 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
723 724 725 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 723 def publish_time @publish_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
730 731 732 733 734 735 |
# File 'generated/google/apis/cloudscheduler_v1/classes.rb', line 730 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 |