// This is an automatically generated code sample.
// To make this code sample work in your Oracle Cloud tenancy,
// please replace the values for any parameters whose current values do not fit
// your use case (such as resource IDs, strings containing ‘EXAMPLE’ or ‘unique_id’, and
// boolean, number, and enum parameters with values not fitting your use case).
import * as dataintegration from "oci-dataintegration";
import common = require("oci-common");
// Create a default authentication provider that uses the DEFAULT
// profile in the configuration file.
// Refer to <see href="https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File>the public documentation</see> on how to prepare a configuration file.
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
(async () => {
try {
// Create a service client
const client = new dataintegration.DataIntegrationClient({
authenticationDetailsProvider: provider
});
// Create a request and dependent object(s).
const createEntityShapeDetails = ({
modelType: "FILE_ENTITY",
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value",
objectVersion: 864,
externalKey: "EXAMPLE-externalKey-Value",
shape: ({
modelType: "SHAPE",
type: ({
modelType: "MATERIALIZED_COMPOSITE_TYPE",
elements: ["EXAMPLE--Value"],
pathNames: ["EXAMPLE--Value"],
configDefinition: ({
key: "EXAMPLE-key-Value",
modelType: "EXAMPLE-modelType-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
isContained: true,
objectStatus: 331,
configParameterDefinitions: {
EXAMPLE_KEY_Z0dYo: ({
parameterName: "EXAMPLE-parameterName-Value",
description: "EXAMPLE-description-Value",
defaultValue: "EXAMPLE-defaultValue-Value",
classFieldName: "EXAMPLE-classFieldName-Value",
isStatic: true,
isClassFieldValue: false
} as unknown) as dataintegration.models.ConfigParameterDefinition
}
} as unknown) as dataintegration.models.ConfigDefinition,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
objectStatus: 878,
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.MaterializedCompositeType,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_7jOQN: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 676,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 763,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.Shape,
shapeId: "ocid1.test.oc1..<unique_ID>EXAMPLE-shapeId-Value",
types: ({
key: "EXAMPLE-key-Value",
modelType: "EXAMPLE-modelType-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value",
objectVersion: 934,
types: {
EXAMPLE_KEY_gVdnM: ({
modelType: "DERIVED_TYPE",
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
objectStatus: 511,
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.DerivedType
},
objectStatus: 540,
identifier: "EXAMPLE-identifier-Value"
} as unknown) as dataintegration.models.TypeLibrary,
entityType: dataintegration.models.CreateEntityShapeFromFile.EntityType.Table,
otherTypeLabel: "EXAMPLE-otherTypeLabel-Value",
uniqueKeys: [
({
modelType: "UNIQUE_KEY",
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
attributeRefs: [
({
position: 869,
shapeField: ({
modelType: "SHAPE_FIELD",
type: "EXAMPLE-type-Value",
labels: ["EXAMPLE--Value"],
nativeShapeField: ({
name: "EXAMPLE-name-Value",
modelType: "EXAMPLE-modelType-Value",
type: "EXAMPLE-type-Value",
configValues: ({
configParamValues: {
EXAMPLE_KEY_Fkr9n: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 165,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
position: 334,
defaultValueString: "EXAMPLE-defaultValueString-Value",
isMandatory: true
} as unknown) as dataintegration.models.NativeShapeField,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_DWzBk: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 529,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 812,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.ShapeField,
attribute: ({
modelType: "SHAPE_FIELD",
type: "EXAMPLE-type-Value",
labels: ["EXAMPLE--Value"],
nativeShapeField: ({
name: "EXAMPLE-name-Value",
modelType: "EXAMPLE-modelType-Value",
type: "EXAMPLE-type-Value",
configValues: ({
configParamValues: {
EXAMPLE_KEY_7DMZm: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 641,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
position: 993,
defaultValueString: "EXAMPLE-defaultValueString-Value",
isMandatory: true
} as unknown) as dataintegration.models.NativeShapeField,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_M6wS8: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 398,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 729,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.ShapeField
} as unknown) as dataintegration.models.KeyAttribute
],
objectStatus: 699
} as unknown) as dataintegration.models.UniqueDataKey
],
foreignKeys: [
({
modelType: "FOREIGN_KEY",
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
attributeRefs: [
({
position: 758,
shapeField: ({
modelType: "SHAPE_FIELD",
type: "EXAMPLE-type-Value",
labels: ["EXAMPLE--Value"],
nativeShapeField: ({
name: "EXAMPLE-name-Value",
modelType: "EXAMPLE-modelType-Value",
type: "EXAMPLE-type-Value",
configValues: ({
configParamValues: {
EXAMPLE_KEY_iJV7j: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 161,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
position: 330,
defaultValueString: "EXAMPLE-defaultValueString-Value",
isMandatory: true
} as unknown) as dataintegration.models.NativeShapeField,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_HvfKc: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 450,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 558,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.ShapeField,
attribute: ({
modelType: "SHAPE_FIELD",
type: "EXAMPLE-type-Value",
labels: ["EXAMPLE--Value"],
nativeShapeField: ({
name: "EXAMPLE-name-Value",
modelType: "EXAMPLE-modelType-Value",
type: "EXAMPLE-type-Value",
configValues: ({
configParamValues: {
EXAMPLE_KEY_6stOJ: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 4,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
position: 607,
defaultValueString: "EXAMPLE-defaultValueString-Value",
isMandatory: false
} as unknown) as dataintegration.models.NativeShapeField,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_m6J1X: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 370,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 324,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.ShapeField
} as unknown) as dataintegration.models.KeyAttribute
],
updateRule: 937,
deleteRule: 544,
referenceUniqueKey: ({
modelType: "PRIMARY_KEY",
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
name: "EXAMPLE-name-Value",
attributeRefs: [
({
position: 0,
shapeField: ({
modelType: "SHAPE_FIELD",
type: "EXAMPLE-type-Value",
labels: ["EXAMPLE--Value"],
nativeShapeField: ({
name: "EXAMPLE-name-Value",
modelType: "EXAMPLE-modelType-Value",
type: "EXAMPLE-type-Value",
configValues: ({
configParamValues: {
EXAMPLE_KEY_DnBfo: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 122,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
position: 788,
defaultValueString: "EXAMPLE-defaultValueString-Value",
isMandatory: false
} as unknown) as dataintegration.models.NativeShapeField,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_CiUI0: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 840,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 335,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.ShapeField,
attribute: ({
modelType: "SHAPE_FIELD",
type: "EXAMPLE-type-Value",
labels: ["EXAMPLE--Value"],
nativeShapeField: ({
name: "EXAMPLE-name-Value",
modelType: "EXAMPLE-modelType-Value",
type: "EXAMPLE-type-Value",
configValues: ({
configParamValues: {
EXAMPLE_KEY_WrKcl: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 596,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
position: 84,
defaultValueString: "EXAMPLE-defaultValueString-Value",
isMandatory: true
} as unknown) as dataintegration.models.NativeShapeField,
key: "EXAMPLE-key-Value",
modelVersion: "EXAMPLE-modelVersion-Value",
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference,
configValues: ({
configParamValues: {
EXAMPLE_KEY_PEbxg: ({
stringValue: "EXAMPLE-stringValue-Value",
intValue: 64,
objectValue: "EXAMPLE-objectValue-Value",
refValue: "EXAMPLE-refValue-Value",
parameterValue: "EXAMPLE-parameterValue-Value",
rootObjectValue: "EXAMPLE-rootObjectValue-Value"
} as unknown) as dataintegration.models.ConfigParameterValue
},
parentRef: ({
parent: "EXAMPLE-parent-Value",
rootDocId: "ocid1.test.oc1..<unique_ID>EXAMPLE-rootDocId-Value"
} as unknown) as dataintegration.models.ParentReference
} as unknown) as dataintegration.models.ConfigValues,
objectStatus: 517,
name: "EXAMPLE-name-Value",
description: "EXAMPLE-description-Value"
} as unknown) as dataintegration.models.ShapeField
} as unknown) as dataintegration.models.KeyAttribute
],
objectStatus: 490
} as unknown) as dataintegration.models.PrimaryKey,
objectStatus: 904
} as unknown) as dataintegration.models.ForeignKey
],
resourceName: "EXAMPLE-resourceName-Value",
dataFormat: ({
formatAttribute: ({
modelType: "CSV_FORMAT",
encoding: "EXAMPLE-encoding-Value",
escapeCharacter: "EXAMPLE-escapeCharacter-Value",
delimiter: "EXAMPLE-delimiter-Value",
quoteCharacter: "EXAMPLE-quoteCharacter-Value",
hasHeader: false,
timestampFormat: "EXAMPLE-timestampFormat-Value",
isFilePattern: true
} as unknown) as dataintegration.models.CsvFormatAttribute,
type: dataintegration.models.DataFormat.Type.Json,
compressionConfig: ({
codec: dataintegration.models.Compression.Codec.Lz4
} as unknown) as dataintegration.models.Compression
} as unknown) as dataintegration.models.DataFormat,
objectStatus: 597,
identifier: "EXAMPLE-identifier-Value"
} as unknown) as dataintegration.models.CreateEntityShapeFromFile;
const createEntityShapeRequest: dataintegration.requests.CreateEntityShapeRequest = {
workspaceId: "ocid1.test.oc1..<unique_ID>EXAMPLE-workspaceId-Value",
connectionKey: "EXAMPLE-connectionKey-Value",
schemaResourceName: "EXAMPLE-schemaResourceName-Value",
createEntityShapeDetails: createEntityShapeDetails,
opcRequestId: "OXXTLA1AA0LC0NHOTSJS<unique_ID>",
opcRetryToken: "EXAMPLE-opcRetryToken-Value",
ifMatch: "EXAMPLE-ifMatch-Value"
};
// Send request to the Client.
const createEntityShapeResponse = await client.createEntityShape(createEntityShapeRequest);
} catch (error) {
console.log("createEntityShape Failed with error " + error);
}
})();