Label

  • Label resources are identified by a resource name in the format customers/{customer_id}/labels/{label_id}.

  • Labels have a status that indicates their current state, which is read-only.

  • The text_label field represents a type of label that displays text on a colored background.

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

  • When creating a new label, the name field is required, must not be empty, and should be between 1 and 80 characters long.

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.