Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateConnectionDetails

Properties used in connection update operations.

Properties

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertySetUsage>

The list of customized properties along with the values for this object

Optional description

description: undefined | string

A description of the connection.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional encProperties

encProperties: undefined | object

A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {@code {"encProperties": { "default": { "password": "example-password"}}}}

Optional isDefault

isDefault: undefined | false | true

Indicates whether this connection is the default connection.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: {@code {"properties": { "default": { "username": "user1"}}}}

Functions

getDeserializedJsonObj

getJsonObj