Stackdriver Trace V2 Client - Class MessageEvent (1.5.3)

Reference documentation and code samples for the Stackdriver Trace V2 Client class MessageEvent.

An event describing a message sent/received between Spans.

Generated from protobuf message google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ type int

Type of MessageEvent. Indicates whether the message was sent or received.

↳ id int|string

An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents.

↳ uncompressed_size_bytes int|string

The number of uncompressed bytes sent or received.

↳ compressed_size_bytes int|string

The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.

getType

Type of MessageEvent. Indicates whether the message was sent or received.

Returns
TypeDescription
int

setType

Type of MessageEvent. Indicates whether the message was sent or received.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getId

An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents.

Returns
TypeDescription
int|string

setId

An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getUncompressedSizeBytes

The number of uncompressed bytes sent or received.

Returns
TypeDescription
int|string

setUncompressedSizeBytes

The number of uncompressed bytes sent or received.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getCompressedSizeBytes

The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.

Returns
TypeDescription
int|string

setCompressedSizeBytes

The number of compressed bytes sent or received. If missing, the compressed size is assumed to be the same size as the uncompressed size.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this