Docs Support

TruncatableString

JSON representation

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

JSON representation
{ "value": string, "truncatedByteCount": integer }

Fields

Fields
`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.
`truncatedByteCount`	`integer` The number of bytes removed from the original string. If this value is 0, then the string was not shortened.

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.

truncatedByteCount

integer

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2020-12-10 UTC.