Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataIntegrationClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • DataIntegrationClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DataIntegrationClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): DataIntegrationClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "DataIntegration"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://dataintegration.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeCompartment

changeDisApplicationCompartment

close

  • close(): void

createApplication

createApplicationDetailedDescription

createConnection

createConnectionValidation

createCopyObjectRequest

createDataAsset

createDataFlow

  • Creates a new data flow in a project or folder ready for performing data integrations.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDataFlow API.

    Parameters

    Returns Promise<CreateDataFlowResponse>

    CreateDataFlowResponse

createDataFlowValidation

createDisApplication

createDisApplicationDetailedDescription

createEntityShape

createExportRequest

createExternalPublication

createExternalPublicationValidation

createFolder

  • Creates a folder in a project or in another folder, limited to two levels of folders. | Folders are used to organize your design-time resources, such as tasks or data flows.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateFolder API.

    Parameters

    Returns Promise<CreateFolderResponse>

    CreateFolderResponse

createFunctionLibrary

  • Creates a function library in a project or in another function library, limited to two levels of function libraries. | FunctionLibraries are used to organize your design-time resources, such as tasks or data flows.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateFunctionLibrary API.

    Parameters

    Returns Promise<CreateFunctionLibraryResponse>

    CreateFunctionLibraryResponse

createImportRequest

createPatch

createPipeline

  • Creates a new pipeline in a project or folder ready for performing task orchestration.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePipeline API.

    Parameters

    Returns Promise<CreatePipelineResponse>

    CreatePipelineResponse

createPipelineValidation

createProject

  • Creates a project. Projects are organizational constructs within a workspace that you use to organize your design-time resources, such as tasks or data flows. Projects can be organized into folders.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateProject API.

    Parameters

    Returns Promise<CreateProjectResponse>

    CreateProjectResponse

createSchedule

createTask

  • Creates a new task ready for performing data integrations. There are specialized types of tasks that include data loader and integration tasks.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTask API.

    Parameters

    Returns Promise<CreateTaskResponse>

    CreateTaskResponse

createTaskRun

createTaskSchedule

createTaskValidation

createUserDefinedFunction

createUserDefinedFunctionValidation

createWaiters

createWorkspace

  • Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateWorkspace API.

    Parameters

    Returns Promise<CreateWorkspaceResponse>

    CreateWorkspaceResponse

deleteApplication

deleteApplicationDetailedDescription

deleteConnection

deleteConnectionValidation

deleteCopyObjectRequest

deleteDataAsset

deleteDataFlow

deleteDataFlowValidation

deleteDisApplication

deleteDisApplicationDetailedDescription

deleteExportRequest

deleteExternalPublication

deleteExternalPublicationValidation

deleteFolder

deleteFunctionLibrary

deleteImportRequest

deletePatch

deletePipeline

deletePipelineValidation

deleteProject

deleteSchedule

deleteTask

deleteTaskRun

deleteTaskSchedule

deleteTaskValidation

deleteUserDefinedFunction

deleteUserDefinedFunctionValidation

deleteWorkspace

getApplication

getApplicationDetailedDescription

getCompositeState

getConnection

getConnectionValidation

getCopyObjectRequest

getCountStatistic

  • Retrieves statistics on a workspace. It returns an object with an array of property values, such as the number of projects, | applications, data assets, and so on.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCountStatistic API.

    Parameters

    Returns Promise<GetCountStatisticResponse>

    GetCountStatisticResponse

getDataAsset

getDataEntity

getDataFlow

getDataFlowValidation

getDependentObject

getDisApplication

getDisApplicationDetailedDescription

getExportRequest

getExternalPublication

getExternalPublicationValidation

getFolder

getFunctionLibrary

getImportRequest

getPatch

  • Retrieves a patch in an application using the specified identifier. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPatch API.

    Parameters

    Returns Promise<GetPatchResponse>

    GetPatchResponse

getPipeline

getPipelineValidation

getProject

getPublishedObject

getReference

getRuntimeOperator

getRuntimePipeline

getSchedule

getSchema

  • Retrieves a schema that can be accessed using the specified connection. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSchema API.

    Parameters

    Returns Promise<GetSchemaResponse>

    GetSchemaResponse

getTask

  • Retrieves a task using the specified identifier. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTask API.

    Parameters

    Returns Promise<GetTaskResponse>

    GetTaskResponse

getTaskRun

getTaskSchedule

getTaskValidation

getTemplate

  • This endpoint can be used to get an application template using a key. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTemplate API.

    Parameters

    Returns Promise<GetTemplateResponse>

    GetTemplateResponse

getUserDefinedFunction

getUserDefinedFunctionValidation

getWaiters

getWorkRequest

getWorkspace

  • Retrieves a Data Integration workspace using the specified identifier. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkspace API.

    Parameters

    Returns Promise<GetWorkspaceResponse>

    GetWorkspaceResponse

listAllTaskRunLogs

  • NOTE: This function is deprecated in favor of listTaskRunLogsRecordIterator function. Creates a new async iterator which will iterate over the models.TaskRunLogSummary objects contained in responses from the listTaskRunLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TaskRunLogSummary>

listAllTaskRunLogsResponses

  • NOTE: This function is deprecated in favor of listTaskRunLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTaskRunLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTaskRunLogsResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listAllWorkspaces

  • NOTE: This function is deprecated in favor of listWorkspacesRecordIterator function. Creates a new async iterator which will iterate over the models.WorkspaceSummary objects contained in responses from the listWorkspaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkspaceSummary>

listAllWorkspacesResponses

  • NOTE: This function is deprecated in favor of listWorkspacesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkspaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkspacesResponse>

listApplications

listConnectionValidations

listConnections

listCopyObjectRequests

listDataAssets

listDataEntities

listDataFlowValidations

listDataFlows

listDependentObjects

listDisApplicationTaskRunLineages

listDisApplications

listExportRequests

listExternalPublicationValidations

listExternalPublications

listFolders

  • Retrieves a list of folders in a project and provides options to filter the list.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFolders API.

    Parameters

    Returns Promise<ListFoldersResponse>

    ListFoldersResponse

listFunctionLibraries

listImportRequests

listPatchChanges

listPatches

  • Retrieves a list of patches in an application and provides options to filter the list. For listing changes based on a period and logical objects changed, see ListPatchChanges API. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPatches API.

    Parameters

    Returns Promise<ListPatchesResponse>

    ListPatchesResponse

listPipelineValidations

listPipelines

  • Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPipelines API.

    Parameters

    Returns Promise<ListPipelinesResponse>

    ListPipelinesResponse

listProjects

  • Retrieves a lists of projects in a workspace and provides options to filter the list.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListProjects API.

    Parameters

    Returns Promise<ListProjectsResponse>

    ListProjectsResponse

listPublishedObjects

listReferences

  • Retrieves a list of references in an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListReferences API.

    Parameters

    Returns Promise<ListReferencesResponse>

    ListReferencesResponse

listRuntimeOperators

listRuntimePipelines

listSchedules

listSchemas

  • Retrieves a list of all the schemas that can be accessed using the specified connection. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSchemas API.

    Parameters

    Returns Promise<ListSchemasResponse>

    ListSchemasResponse

listTaskRunLineages

listTaskRunLogs

listTaskRunLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.TaskRunLogSummary objects contained in responses from the listTaskRunLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TaskRunLogSummary>

listTaskRunLogsResponseIterator

listTaskRuns

listTaskSchedules

listTaskValidations

listTasks

  • Retrieves a list of all tasks in a specified project or folder.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTasks API.

    Parameters

    Returns Promise<ListTasksResponse>

    ListTasksResponse

listTemplates

  • This endpoint can be used to list application templates with filtering options. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTemplates API.

    Parameters

    Returns Promise<ListTemplatesResponse>

    ListTemplatesResponse

listUserDefinedFunctionValidations

listUserDefinedFunctions

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

listWorkRequestLogsResponseIterator

listWorkRequests

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

listWorkspaces

listWorkspacesRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkspaceSummary objects contained in responses from the listWorkspaces operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkspaceSummary>

listWorkspacesResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startWorkspace

stopWorkspace

updateApplication

updateApplicationDetailedDescription

updateConnection

updateCopyObjectRequest

updateDataAsset

updateDataFlow

updateDisApplication

updateDisApplicationDetailedDescription

updateExportRequest

updateExternalPublication

updateFolder

updateFunctionLibrary

updateImportRequest

updatePipeline

updateProject

updateReference

  • Updates the application references. For example, to map a data asset to a different target object. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateReference API.

    Parameters

    Returns Promise<UpdateReferenceResponse>

    UpdateReferenceResponse

updateSchedule

updateTask

  • Updates a specific task. For example, you can update the task description or move the task to a different folder by changing the aggregatorKey to a different folder in the registry. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTask API.

    Parameters

    Returns Promise<UpdateTaskResponse>

    UpdateTaskResponse

updateTaskRun

updateTaskSchedule

updateUserDefinedFunction

updateWorkspace