Stackdriver Trace V2 Client - Class TruncatableString (1.5.3)

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

Represents a string that might be shortened to a specified length.

Generated from protobuf message google.devtools.cloudtrace.v2.TruncatableString

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ value string

The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then value contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.

↳ truncated_byte_count int

The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

getValue

The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then value contains the first 128 bytes of the 500-byte string.

Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.

Returns
TypeDescription
string

setValue

The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then value contains the first 128 bytes of the 500-byte string.

Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTruncatedByteCount

The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

Returns
TypeDescription
int

setTruncatedByteCount

The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

Parameter
NameDescription
var int
Returns
TypeDescription
$this