Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateConnectionDetails

Properties used in connection create operations.

Properties

Optional connectionProperties

connectionProperties: Array<ConnectionProperty>

The properties for the connection.

Optional description

description: undefined | string

User-defined description for the connection.

identifier

identifier: string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional key

key: undefined | string

Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create.

modelType

modelType: string

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

name

name: string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional registryMetadata

registryMetadata: model.RegistryMetadata

Functions

getDeserializedJsonObj

getJsonObj