Class: Google::Apis::DataflowV1b3::StructuredMessage

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

Overview

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.

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) ⇒ StructuredMessage

Returns a new instance of StructuredMessage.



4888
4889
4890
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4888

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

Instance Attribute Details

#message_key ⇒ String

Identifier for this message type. Used by external systems to internationalize or personalize message. Corresponds to the JSON property messageKey

Returns:

  • (String) 


4876
4877
4878
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4876

def message_key
  @message_key
end

#message_text ⇒ String

Human-readable version of message. Corresponds to the JSON property messageText

Returns:

  • (String) 


4881
4882
4883
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4881

def message_text
  @message_text
end

#parameters ⇒ Array<Google::Apis::DataflowV1b3::Parameter>

The structured data associated with this message. Corresponds to the JSON property parameters

Returns:



4886
4887
4888
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4886

def parameters
  @parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4893
4894
4895
4896
4897
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4893

def update!(**args)
  @message_key = args[:message_key] if args.key?(:message_key)
  @message_text = args[:message_text] if args.key?(:message_text)
  @parameters = args[:parameters] if args.key?(:parameters)
end