Label

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

  • Labels have a status, which is read-only.

  • Labels can display text on a colored background using the TextLabel type.

  • Each label has a unique, read-only ID.

  • Labels require a name between 1 and 80 characters when created.

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.