Class: Credentials

dg.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

Hierarchy

• Entity

  ↳ Credentials

Constructors

constructor

• new Credentials(dart)

Parameters

Name	Type
dart	any

Overrides

Entity.constructor

Defined in

src/entities.ts:847

Properties

dart

• dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

---

parameters

• parameters: 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.

Defined in

src/entities.ts:845

Accessors

author

• get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77

---

name

• get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92

---

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>

Defined in

src/entities.ts:857

---

path

• get path(): string

Entity path

Returns

string

Inherited from

Entity.path

Defined in

src/entities.ts:95

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101

Methods

getProperties

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

Gets entity properties

Returns

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

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125