Label

  • A label resource is identified by a unique resource name including the customer and label ID.

  • Labels have a status that indicates their current state and are read-only.

  • A TextLabel is a specific type of label used for displaying text.

  • Each label has a unique ID that is read-only.

  • Labels are given a name that is required upon creation and has a character limit of 1 to 80.

A label.

Fields

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.

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.