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 | |
|---|---|
| Name | Description |
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. It is recommended to be unique within a Span. |
↳ 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 assumed to be the same size as uncompressed. |
getType
Type of MessageEvent. Indicates whether the message was sent or received.
Generated from protobuf field .google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent.Type type = 1;
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Type of MessageEvent. Indicates whether the message was sent or received.
Generated from protobuf field .google.devtools.cloudtrace.v2.Span.TimeEvent.MessageEvent.Type type = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.
Generated from protobuf field int64 id = 2;
| Returns | |
|---|---|
| Type | Description |
int|string | |
setId
An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.
Generated from protobuf field int64 id = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUncompressedSizeBytes
The number of uncompressed bytes sent or received.
Generated from protobuf field int64 uncompressed_size_bytes = 3;
| Returns | |
|---|---|
| Type | Description |
int|string | |
setUncompressedSizeBytes
The number of uncompressed bytes sent or received.
Generated from protobuf field int64 uncompressed_size_bytes = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompressedSizeBytes
The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.
Generated from protobuf field int64 compressed_size_bytes = 4;
| Returns | |
|---|---|
| Type | Description |
int|string | |
setCompressedSizeBytes
The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.
Generated from protobuf field int64 compressed_size_bytes = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |