Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::StructuredMessage.
A rich message format, including a human readable string, a key for
identifying the message, and structured data associated with the message for
programmatic consumption.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#message_key
defmessage_key()->::String
Returns
(::String) — Identifier for this message type. Used by external systems to
internationalize or personalize message.
#message_key=
defmessage_key=(value)->::String
Parameter
value (::String) — Identifier for this message type. Used by external systems to
internationalize or personalize message.
Returns
(::String) — Identifier for this message type. Used by external systems to
internationalize or personalize message.
#message_text
defmessage_text()->::String
Returns
(::String) — Human-readable version of message.
#message_text=
defmessage_text=(value)->::String
Parameter
value (::String) — Human-readable version of message.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::StructuredMessage (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.13.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.12.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.12.1/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.11.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.10.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.9.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.9.1/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.8.2](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.8.2/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.7.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.6.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.6.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.5.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.4.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.3.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.2.0/Google-Cloud-Dataflow-V1beta3-StructuredMessage)\n- [0.1.4](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.1.4/Google-Cloud-Dataflow-V1beta3-StructuredMessage) \nReference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::StructuredMessage.\n\nA rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #message_key\n\n def message_key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier for this message type. Used by external systems to internationalize or personalize message.\n\n### #message_key=\n\n def message_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier for this message type. Used by external systems to internationalize or personalize message. \n**Returns**\n\n- (::String) --- Identifier for this message type. Used by external systems to internationalize or personalize message.\n\n### #message_text\n\n def message_text() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Human-readable version of message.\n\n### #message_text=\n\n def message_text=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Human-readable version of message. \n**Returns**\n\n- (::String) --- Human-readable version of message.\n\n### #parameters\n\n def parameters() -\u003e ::Array\u003c::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter](./Google-Cloud-Dataflow-V1beta3-StructuredMessage-Parameter)\\\u003e) --- The structured data associated with this message.\n\n### #parameters=\n\n def parameters=(value) -\u003e ::Array\u003c::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter](./Google-Cloud-Dataflow-V1beta3-StructuredMessage-Parameter)\\\u003e) --- The structured data associated with this message. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Dataflow::V1beta3::StructuredMessage::Parameter](./Google-Cloud-Dataflow-V1beta3-StructuredMessage-Parameter)\\\u003e) --- The structured data associated with this message."]]
