LabelDescriptor

A description of a label.

JSON representation
{"key":string,"valueType":enum (ValueType),"description":string}
Fields
key

string

The key for this label. The key must meet the following criteria:

  • Does not exceed 100 characters.
  • Matches the following regular expression:[a-zA-Z][a-zA-Z0-9_]*
    • The first character must be an upper- or lower-case letter.
    • The remaining characters must be letters, digits, or underscores.
valueType

enum (ValueType)

The type of data that can be assigned to the label.

description

string

A human-readable description for the label.

ValueType

Value types that can be used as label values.

Enums
STRINGA variable-length string, not to exceed 1,024 characters. This is the default value type.
BOOLBoolean; true or false.
INT64A 64-bit signed integer.

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

Last updated 2025-07-23 UTC.