Skip to content

nogroup.backstage.entityMeta

"Metadata fields common to all versions/kinds of entity."

Index

Fields

fn withAnnotations

withAnnotations(annotations)

"Key/value pairs of non-identifying auxiliary information attached to the entity."

fn withAnnotationsMixin

withAnnotationsMixin(annotations)

"Key/value pairs of non-identifying auxiliary information attached to the entity."

Note: This function appends passed data to existing values

fn withDescription

withDescription(description)

"A short (typically relatively few words, on one line) description of the entity."

fn withEtag

withEtag(etag)

"An opaque string that changes for each update operation to any part of the entity, including metadata. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, and the server will then reject the operation if it does not match the current stored value."

fn withLabels

withLabels(labels)

"Key/value pairs of identifying information attached to the entity."

fn withLabelsMixin

withLabelsMixin(labels)

"Key/value pairs of identifying information attached to the entity."

Note: This function appends passed data to existing values

withLinks(links)

"A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page."

fn withLinksMixin

withLinksMixin(links)

"A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page."

Note: This function appends passed data to existing values

fn withName

withName(name)

"The name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair."

fn withNamespace

withNamespace(namespace)

"The namespace that the entity belongs to."

fn withTags

withTags(tags)

"A list of single-valued strings, to for example classify catalog entities in various ways."

fn withTagsMixin

withTagsMixin(tags)

"A list of single-valued strings, to for example classify catalog entities in various ways."

Note: This function appends passed data to existing values

fn withTitle

withTitle(title)

"A display name of the entity, to be presented in user interfaces instead of the name property, when available."

fn withUid

withUid(uid)

"A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, but the server is free to reject requests that do so in such a way that it breaks semantics."

"A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page."

fn links.withIcon

withIcon(icon)

"A key representing a visual icon to be displayed in the UI."

fn links.withTitle

withTitle(title)

"A user friendly display name for the link."

fn links.withType

withType(type)

"An optional value to categorize links into specific groups."

fn links.withUrl

withUrl(url)

"A url in a standard uri format."