DockerImage

Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path

Extends

• Entity

Constructors

new DockerImage()

new DockerImage(dart): DockerImage

Parameters

Parameter	Type
dart	any

Returns

DockerImage

Overrides

Entity . constructor

Source

src/api/grok_shared.api.g.ts:265

Properties

Property	Modifier	Type	Default value	Inherited from
dart	public	any	undefined	Entity.dart
STATUS_BUILDING	static	string	'building'	-
STATUS_ERROR	static	string	'error'	-
STATUS_PENDING_BUILD	static	string	'pending build'	-
STATUS_READY	static	string	'ready'	-
dbTableName	static	string	'dockerfiles'	-

Accessors

author

get author(): any

Who created entity *

Returns

any

Source

src/entities/entity.ts:59

---

completed

get completed(): boolean

Returns

boolean

Source

src/api/grok_shared.api.g.ts:294

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities/entity.ts:50

---

description

get description(): string

set description(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:278

---

dockerFullName

get dockerFullName(): string

Returns

string

Source

src/api/grok_shared.api.g.ts:298

---

dockerName

get dockerName(): string

set dockerName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:284

---

dockerfile

get dockerfile(): string

set dockerfile(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:280

---

dockerfilePath

get dockerfilePath(): string

set dockerfilePath(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:288

---

entityType

get entityType(): string

Entity type name *

Returns

string

Source

src/entities/entity.ts:66

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities/entity.ts:36

---

iconStatus

get iconStatus(): string

Returns

string

Source

src/api/grok_shared.api.g.ts:296

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities/entity.ts:28

---

logs

get logs(): string

set logs(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:292

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities/entity.ts:40

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities/entity.ts:44

---

path

get path(): string

Entity path

Returns

string

Source

src/entities/entity.ts:47

---

status

get status(): string

set status(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:282

---

updatedBy

get updatedBy(): string

set updatedBy(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:290

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities/entity.ts:53

---

version

get version(): string

set version(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/api/grok_shared.api.g.ts:286

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities/entity.ts:69

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities/entity.ts:81

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities/entity.ts:32

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities/entity.ts:74

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities/entity.ts:84

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities/entity.ts:79

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities/entity.ts:87

---

fromJson()

static fromJson(map): DockerImage

Parameters

Parameter	Type
map	object

Returns

DockerImage

Source

src/api/grok_shared.api.g.ts:267