Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MigrationParameterSummary

Migration parameter response object.

Properties

Functions

Properties

categoryDisplayName

categoryDisplayName: string

Parameter category display name.

categoryName

categoryName: string

Parameter category name.

dataType

dataType: AdvancedParameterDataTypes

Parameter data type.

databaseCombination

databaseCombination: DatabaseCombination

The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases.

Optional defaultValue

defaultValue: undefined | string

Default value for a parameter.

description

description: string

Parameter name description.

displayName

displayName: string

Parameter display name.

Optional docUrlLink

docUrlLink: undefined | string

Parameter documentation URL link.

Optional hintText

hintText: undefined | string

Hint text for parameter value.

Optional maxValue

maxValue: undefined | number

Parameter maximum value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

migrationType

migrationType: MigrationTypes

Migration Stage.

Optional minValue

minValue: undefined | number

Parameter minimum value. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

name

name: string

Parameter name.

Functions

getDeserializedJsonObj

getJsonObj