Label

  • Label resources are identified by a resource name that includes customer and label IDs.

  • The label status is output only and read-only, reflecting its current state.

  • Text labels are a type that displays text with a colored background.

  • Labels have an output-only, read-only ID and a required name between 1 and 80 characters.

A label.

Proto definition

Fields

id

int64

Output only. ID of the label. Read only.

name

string

The name of the label.

This field is required and should not be empty when creating a new label.

The length of this string should be between 1 and 80, inclusive.

resource_name

string

Immutable. Name of the resource. Label resource names have the form:customers/{customer_id}/labels/{label_id}

status

LabelStatus

Output only. Status of the label. Read only.

text_label

TextLabel

A type of label displaying text on a colored background.

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-12-12 UTC.