API Cookbook: ASELinkData

{
    "name": "ASELinkData",
    "description": "SAP ASE specific parameters for a link request.",
    "extends": {
        "$ref": "/delphix-link-data.json"
    },
    "properties": {
        "config": {
            "type": "string",
            "description": "Reference to the configuration for the source.",
            "format": "objectReference",
            "referenceTo": "/delphix-ase-db-config.json",
            "required": true
        },
        "externalFilePath": {
            "type": "string",
            "description": "External file path.",
            "maxLength": 1024,
            "create": "optional",
        },
        "operations": {
            "description": "User-specified operation hooks for this source.",
            "type": "object",
            "$ref": "/delphix-linked-source-operations.json",
            "create": "optional"
        },
        "loadBackupPath": {
            "type": "string",
            "description": "Source database backup location.",
            "maxLength": 1024,
            "required": true
        },
        "loadLocation": {
            "type": ["object", "null"],
            "description": "Backup location to use for loading backups from the source.",
            "$ref": "/delphix-ase-backup-location.json",
            "create": "optional"
        },
        "dumpCredentials": {
            "type": ["object", "null"],
            "description": "The credential for the source DB user.",
            "$ref": "/delphix-password-credential.json",
            "create": "optional"
        },
        "sourceHostUser": {
            "type": "string",
            "description": "Information about the host OS user on the source to use for linking.",
            "format": "objectReference",
            "referenceTo": "/delphix-source-environment-user.json",
            "required": true
        },
        "dbUser": {
            "type": "string",
            "description": "The user name for the source DB user.",
            "create": "optional"
        },
        "dbCredentials": {
            "type": "object",
            "description": "The credentials of the database user.",
            "$ref": "/delphix-credential.json",
            "required": true,
            "properties": {
                "type": {
                    "type": "string",
                    "description": "Object type.",
                    "required": true,
                    "format": "type",
                    "default": "PasswordCredential"
                }
            }
        },
        "stagingRepository": {
            "type": "string",
            "description": "The SAP ASE instance on the staging environment that we want to use for validated sync.",
            "format": "objectReference",
            "referenceTo": "/delphix-ase-instance.json",
            "required": true
        },
       "stagingHostUser": {
            "type": "string",
            "description": "Information about the host OS user on the staging environment to use for linking.",
            "format": "objectReference",
            "referenceTo": "/delphix-source-environment-user.json",
            "required": true
        },
        "stagingPreScript": {
            "type": "string",
            "description": "A user-provided shell script or executable to run prior to restoring from a backup during validated sync.",
            "maxLength": 1024,
            "create": "optional"
        },
        "stagingPostScript": {
             "type": "string",
             "description": "A user-provided shell script or executable to run after restoring from a backup during validated sync.",
             "maxLength": 1024,
             "create": "optional"
        },
        "syncParameters": {
            "type": "object",
            "description": "Sync parameters for the container.",
            "$ref": "/delphix-ase-sync-parameters.json",
            "required": true,
            "properties": {
                "type": {
                    "type": "string",
                    "description": "Object type.",
                    "required": true,
                    "format": "type",
                    "default": "ASELatestBackupSyncParameters"
                }
            }
        },
        "validatedSyncMode": {
            "type": "string",
            "description": "Specifies the validated sync mode to synchronize the dSource with the source database.",
            "enum": ["ENABLED", "DISABLED"],
            "default": "ENABLED",
            "create": "optional"
        }
    }
}