DockerImage

Defined in: js-api/src/api/grok_shared.api.g.ts:304

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

Extends

• Entity

Constructors

Constructor

new DockerImage(dart): DockerImage

Defined in: js-api/src/api/grok_shared.api.g.ts:305

Parameters

Parameter	Type
dart	any

Returns

DockerImage

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
dart	public	any	undefined	Entity.dart	js-api/src/entities/entity.ts:19
dbTableName	static	string	'dockerfiles'	-	js-api/src/api/grok_shared.api.g.ts:318
STATUS_DELETED	static	string	'deleted'	-	js-api/src/api/grok_shared.api.g.ts:316
STATUS_ERROR	static	string	'error'	-	js-api/src/api/grok_shared.api.g.ts:310
STATUS_PENDING_VALIDATION	static	string	'pending validation'	-	js-api/src/api/grok_shared.api.g.ts:312
STATUS_READY	static	string	'ready'	-	js-api/src/api/grok_shared.api.g.ts:308
STATUS_VALIDATING	static	string	'validating'	-	js-api/src/api/grok_shared.api.g.ts:314

Accessors

author

Get Signature

get author(): any

Defined in: js-api/src/entities/entity.ts:57

Who created entity *

Returns

any

Inherited from

Entity.author

---

completed

Get Signature

get completed(): boolean

Defined in: js-api/src/api/grok_shared.api.g.ts:339

Returns

boolean

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:48

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

description

Get Signature

get description(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:320

Returns

string

Set Signature

set description(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:321

Parameters

Parameter	Type
x	string

Returns

void

---

dockerfile

Get Signature

get dockerfile(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:322

Returns

string

Set Signature

set dockerfile(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:323

Parameters

Parameter	Type
x	string

Returns

void

---

dockerfilePath

Get Signature

get dockerfilePath(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:330

Returns

string

Set Signature

set dockerfilePath(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:331

Parameters

Parameter	Type
x	string

Returns

void

---

dockerFullName

Get Signature

get dockerFullName(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:343

Returns

string

---

dockerName

Get Signature

get dockerName(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:326

Returns

string

Set Signature

set dockerName(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:327

Parameters

Parameter	Type
x	string

Returns

void

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:64

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:34

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:35

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

iconStatus

Get Signature

get iconStatus(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:341

Returns

string

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:27

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:28

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

imageRef

Get Signature

get imageRef(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:337

Published image this entity points at, for packages that reference one instead of building it.

Returns

string

Set Signature

set imageRef(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:338

Parameters

Parameter	Type
x	string

Returns

void

---

logs

Get Signature

get logs(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:334

Returns

string

Set Signature

set logs(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:335

Parameters

Parameter	Type
x	string

Returns

void

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/entity.ts:38

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/entity.ts:39

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:42

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/entity.ts:45

Entity path

Returns

string

Inherited from

Entity.path

---

status

Get Signature

get status(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:324

Returns

string

Set Signature

set status(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:325

Parameters

Parameter	Type
x	string

Returns

void

---

updatedBy

Get Signature

get updatedBy(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:332

Returns

string

Set Signature

set updatedBy(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:333

Parameters

Parameter	Type
x	string

Returns

void

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:51

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

---

version

Get Signature

get version(): string

Defined in: js-api/src/api/grok_shared.api.g.ts:328

Returns

string

Set Signature

set version(x): void

Defined in: js-api/src/api/grok_shared.api.g.ts:329

Parameters

Parameter	Type
x	string

Returns

void

Methods

getProperties()

getProperties(): Promise<{[index: string]: any; }>

Defined in: js-api/src/entities/entity.ts:67

Gets entity properties

Returns

Promise<{[index: string]: any; }>

Inherited from

Entity.getProperties

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:79

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:31

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:72

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:82

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:77

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:85

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

---

fromJson()

static fromJson(map): DockerImage

Defined in: js-api/src/api/grok_shared.api.g.ts:307

Parameters

Parameter	Type
map	{[index: string]: any; }

Returns

DockerImage