Skip to main content

DockerImage

Defined in: src/api/grok_shared.api.g.ts:266

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

Extends

Constructors

Constructor

new DockerImage(dart): DockerImage

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

Parameters

ParameterType
dartany

Returns

DockerImage

Overrides

Entity.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
dartpublicanyundefinedEntity.dartsrc/entities/entity.ts:19
dbTableNamestaticstring'dockerfiles'-src/api/grok_shared.api.g.ts:278
STATUS_BUILDINGstaticstring'building'-src/api/grok_shared.api.g.ts:274
STATUS_ERRORstaticstring'error'-src/api/grok_shared.api.g.ts:272
STATUS_PENDING_BUILDstaticstring'pending build'-src/api/grok_shared.api.g.ts:276
STATUS_READYstaticstring'ready'-src/api/grok_shared.api.g.ts:270

Accessors

author

Get Signature

get author(): any

Defined in: src/entities/entity.ts:59

Who created entity *

Returns

any

Inherited from

Entity.author


completed

Get Signature

get completed(): boolean

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

Returns

boolean


createdOn

Get Signature

get createdOn(): Dayjs

Defined in: src/entities/entity.ts:50

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn


description

Get Signature

get description(): string

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

Returns

string

Set Signature

set description(x): void

Defined in: src/api/grok_shared.api.g.ts:281

Parameters
ParameterType
xstring
Returns

void


dockerfile

Get Signature

get dockerfile(): string

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

Returns

string

Set Signature

set dockerfile(x): void

Defined in: src/api/grok_shared.api.g.ts:283

Parameters
ParameterType
xstring
Returns

void


dockerfilePath

Get Signature

get dockerfilePath(): string

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

Returns

string

Set Signature

set dockerfilePath(x): void

Defined in: src/api/grok_shared.api.g.ts:291

Parameters
ParameterType
xstring
Returns

void


dockerFullName

Get Signature

get dockerFullName(): string

Defined in: src/api/grok_shared.api.g.ts:300

Returns

string


dockerName

Get Signature

get dockerName(): string

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

Returns

string

Set Signature

set dockerName(x): void

Defined in: src/api/grok_shared.api.g.ts:287

Parameters
ParameterType
xstring
Returns

void


entityType

Get Signature

get entityType(): string

Defined in: src/entities/entity.ts:66

Entity type name *

Returns

string

Inherited from

Entity.entityType


friendlyName

Get Signature

get friendlyName(): string

Defined in: src/entities/entity.ts:36

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: src/entities/entity.ts:37

Parameters
ParameterType
xstring
Returns

void

Inherited from

Entity.friendlyName


iconStatus

Get Signature

get iconStatus(): string

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

Returns

string


id

Get Signature

get id(): string

Defined in: src/entities/entity.ts:28

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: src/entities/entity.ts:29

Parameters
ParameterType
xstring
Returns

void

Inherited from

Entity.id


logs

Get Signature

get logs(): string

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

Returns

string

Set Signature

set logs(x): void

Defined in: src/api/grok_shared.api.g.ts:295

Parameters
ParameterType
xstring
Returns

void


name

Get Signature

get name(): string

Defined in: src/entities/entity.ts:40

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: src/entities/entity.ts:41

Parameters
ParameterType
xstring
Returns

void

Inherited from

Entity.name


nqName

Get Signature

get nqName(): string

Defined in: src/entities/entity.ts:44

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName


path

Get Signature

get path(): string

Defined in: src/entities/entity.ts:47

Entity path

Returns

string

Inherited from

Entity.path


status

Get Signature

get status(): string

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

Returns

string

Set Signature

set status(x): void

Defined in: src/api/grok_shared.api.g.ts:285

Parameters
ParameterType
xstring
Returns

void


updatedBy

Get Signature

get updatedBy(): string

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

Returns

string

Set Signature

set updatedBy(x): void

Defined in: src/api/grok_shared.api.g.ts:293

Parameters
ParameterType
xstring
Returns

void


updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: src/entities/entity.ts:53

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn


version

Get Signature

get version(): string

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

Returns

string

Set Signature

set version(x): void

Defined in: src/api/grok_shared.api.g.ts:289

Parameters
ParameterType
xstring
Returns

void

Methods

getProperties()

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

Defined in: src/entities/entity.ts:69

Gets entity properties

Returns

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

Inherited from

Entity.getProperties


hasTag()

hasTag(tag): boolean

Defined in: src/entities/entity.ts:81

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity.hasTag


newId()

newId(): void

Defined in: src/entities/entity.ts:32

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId


setProperties()

setProperties(props): Promise<any>

Defined in: src/entities/entity.ts:74

Sets entity properties

Parameters

ParameterType
props{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties


tag()

tag(tag): boolean

Defined in: src/entities/entity.ts:84

Adds a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity.tag


toString()

toString(): string

Defined in: src/entities/entity.ts:79

Returns a string representing the object

Returns

string

Inherited from

Entity.toString


unTag()

unTag(tag): boolean

Defined in: src/entities/entity.ts:87

Removes a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity.unTag


fromJson()

static fromJson(map): DockerImage

Defined in: src/api/grok_shared.api.g.ts:269

Parameters

ParameterType
map{[index: string]: any; }

Returns

DockerImage