Credentials

Defined in: src/entities/data-connection.ts:396

Represents connection credentials Usually it is a login and a password pair Passwords are stored in the secured credentials storage See also: https://datagrok.ai/help/datagrok/solutions/enterprise/security#credentials

Extends

• Entity

Constructors

Constructor

new Credentials(dart): Credentials

Defined in: src/entities/data-connection.ts:404

Parameters

Parameter	Type
dart	any

Returns

Credentials

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
dart	public	any	-	Entity.dart	src/entities/entity.ts:19
parameters	public	any	Represents credentials parameters that are hidden from other users and when they are used real values of them will be replaced by values from openParameters. Parameters can be filled with key-value entries that are suitable for the entity that owns that Credentials.	-	src/entities/data-connection.ts:402

Accessors

author

Get Signature

get author(): any

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

Who created entity *

Returns

any

Inherited from

Entity.author

---

createdOn

Get Signature

get createdOn(): Dayjs

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

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

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

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

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

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

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

Parameter	Type
x	string

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

---

openParameters

Get Signature

get openParameters(): Record<string, string>

Defined in: src/entities/data-connection.ts:414

Represents opened credential parameters. They will be showed, for example, in the connection edit form. They are updated when parameters are changed and instance is saved. See also CredentialsDataSource.

Returns

Record<string, string>

---

path

Get Signature

get path(): string

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

Entity path

Returns

string

Inherited from

Entity.path

---

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

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

Parameter	Type
tag	string

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

Parameter	Type
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

Parameter	Type
tag	string

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

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag