Credentials

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/govern/security

Extends

• Entity

Constructors

new Credentials()

new Credentials(dart): Credentials

Parameters

Parameter	Type
dart	any

Returns

Credentials

Overrides

Entity . constructor

Source

src/entities.ts:871

Properties

Property	Modifier	Type	Description	Inherited from
dart	public	any	-	Entity.dart
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.	-

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:108

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:99

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:85

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:77

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:89

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:93

---

openParameters

get openParameters(): Record<string, string>

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>

Source

src/entities.ts:881

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:96

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:102

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:111

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:123

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:81

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:116

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:126

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:121

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:129