Google Cloud Dataflow V1beta3 Client - Class StructuredMessage (0.3.10)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class 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.

Generated from protobuf message google.dataflow.v1beta3.StructuredMessage

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ message_text string

Human-readable version of message.

↳ message_key string

Identifier for this message type. Used by external systems to internationalize or personalize message.

↳ parameters array<Google\Cloud\Dataflow\V1beta3\StructuredMessage\Parameter>

The structured data associated with this message.

getMessageText

Human-readable version of message.

Returns
TypeDescription
string

setMessageText

Human-readable version of message.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMessageKey

Identifier for this message type. Used by external systems to internationalize or personalize message.

Returns
TypeDescription
string

setMessageKey

Identifier for this message type. Used by external systems to internationalize or personalize message.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParameters

The structured data associated with this message.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParameters

The structured data associated with this message.

Parameter
NameDescription
var array<Google\Cloud\Dataflow\V1beta3\StructuredMessage\Parameter>
Returns
TypeDescription
$this