Class EntityResponseDataAttributes

Entity response attributes containing core entity metadata fields.

Hierarchy

  • EntityResponseDataAttributes

Constructors

constructor

Properties

additionalProperties? apiVersion? description? displayName? kind? name? namespace? owner? properties? tags?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional apiVersion

apiVersion?: string

The API version of the entity schema.

Optional description

description?: string

A short description of the entity.

Optional displayName

displayName?: string

The user-friendly display name of the entity.

Optional kind

kind?: string

The kind of the entity (e.g. service, datastore, queue).

Optional name

name?: string

The unique name of the entity within its kind and namespace.

Optional namespace

namespace?: string

The namespace the entity belongs to.

Optional owner

owner?: string

The owner of the entity, usually a team.

Optional properties

properties?: {
    [key: string]: any;
}

Additional custom properties for the entity.

Type declaration

  • [key: string]: any

Optional tags

tags?: string[]

A set of custom tags assigned to the entity.

Settings

Member Visibility

Theme

Generated using TypeDoc