Interface DataIntegration
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
DataIntegrationClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20200430") public interface DataIntegration extends AutoCloseable
Use the Data Integration API to organize your data integration projects, create data flows, pipelines and tasks, and then publish, schedule, and run tasks that extract, transform, and load data.For more information, see Data Integration. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ChangeCompartmentResponse
changeCompartment(ChangeCompartmentRequest request)
Moves a workspace to a specified compartment.ChangeDisApplicationCompartmentResponse
changeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest request)
Moves a DIS Application to a specified compartment.CreateApplicationResponse
createApplication(CreateApplicationRequest request)
Creates an application.CreateApplicationDetailedDescriptionResponse
createApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.CreateConnectionResponse
createConnection(CreateConnectionRequest request)
Creates a connection under an existing data asset.CreateConnectionValidationResponse
createConnectionValidation(CreateConnectionValidationRequest request)
Creates a connection validation.CreateCopyObjectRequestResponse
createCopyObjectRequest(CreateCopyObjectRequestRequest request)
Copy Metadata Object.CreateDataAssetResponse
createDataAsset(CreateDataAssetRequest request)
Creates a data asset with default connection.CreateDataFlowResponse
createDataFlow(CreateDataFlowRequest request)
Creates a new data flow in a project or folder ready for performing data integrations.CreateDataFlowValidationResponse
createDataFlowValidation(CreateDataFlowValidationRequest request)
Accepts the data flow definition in the request payload and creates a data flow validation.CreateDisApplicationResponse
createDisApplication(CreateDisApplicationRequest request)
Creates a DIS Application.CreateDisApplicationDetailedDescriptionResponse
createDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.CreateEntityShapeResponse
createEntityShape(CreateEntityShapeRequest request)
Creates the data entity shape using the shape from the data asset.CreateExportRequestResponse
createExportRequest(CreateExportRequestRequest request)
Export Metadata ObjectCreateExternalPublicationResponse
createExternalPublication(CreateExternalPublicationRequest request)
Publish a DataFlow in a OCI DataFlow application.CreateExternalPublicationValidationResponse
createExternalPublicationValidation(CreateExternalPublicationValidationRequest request)
Validates a specific task.CreateFolderResponse
createFolder(CreateFolderRequest request)
Creates a folder in a project or in another folder, limited to two levels of folders.CreateFunctionLibraryResponse
createFunctionLibrary(CreateFunctionLibraryRequest request)
Creates a function library in a project or in another function library, limited to two levels of function libraries.CreateImportRequestResponse
createImportRequest(CreateImportRequestRequest request)
Import Metadata ObjectCreatePatchResponse
createPatch(CreatePatchRequest request)
Creates a patch in an application.CreatePipelineResponse
createPipeline(CreatePipelineRequest request)
Creates a new pipeline in a project or folder ready for performing task orchestration.CreatePipelineValidationResponse
createPipelineValidation(CreatePipelineValidationRequest request)
Accepts the data flow definition in the request payload and creates a pipeline validation.CreateProjectResponse
createProject(CreateProjectRequest request)
Creates a project.CreateScheduleResponse
createSchedule(CreateScheduleRequest request)
Endpoint to create a new scheduleCreateTaskResponse
createTask(CreateTaskRequest request)
Creates a new task ready for performing data integrations.CreateTaskRunResponse
createTaskRun(CreateTaskRunRequest request)
Creates a data integration task run for the specified task.CreateTaskScheduleResponse
createTaskSchedule(CreateTaskScheduleRequest request)
Endpoint to be used create TaskSchedule.CreateTaskValidationResponse
createTaskValidation(CreateTaskValidationRequest request)
Validates a specific task.CreateUserDefinedFunctionResponse
createUserDefinedFunction(CreateUserDefinedFunctionRequest request)
Creates a new UserDefinedFunction in a function library ready for performing data integrations.CreateUserDefinedFunctionValidationResponse
createUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest request)
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.CreateWorkspaceResponse
createWorkspace(CreateWorkspaceRequest request)
Creates a new Data Integration workspace ready for performing data integration tasks.DeleteApplicationResponse
deleteApplication(DeleteApplicationRequest request)
Removes an application using the specified identifier.DeleteApplicationDetailedDescriptionResponse
deleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.DeleteConnectionResponse
deleteConnection(DeleteConnectionRequest request)
Removes a connection using the specified identifier.DeleteConnectionValidationResponse
deleteConnectionValidation(DeleteConnectionValidationRequest request)
Deletes a connection validation.DeleteCopyObjectRequestResponse
deleteCopyObjectRequest(DeleteCopyObjectRequestRequest request)
Delete copy object request using the specified identifier.DeleteDataAssetResponse
deleteDataAsset(DeleteDataAssetRequest request)
Removes a data asset using the specified identifier.DeleteDataFlowResponse
deleteDataFlow(DeleteDataFlowRequest request)
Removes a data flow from a project or folder using the specified identifier.DeleteDataFlowValidationResponse
deleteDataFlowValidation(DeleteDataFlowValidationRequest request)
Removes a data flow validation using the specified identifier.DeleteDisApplicationResponse
deleteDisApplication(DeleteDisApplicationRequest request)
Removes a DIS application using the specified identifier.DeleteDisApplicationDetailedDescriptionResponse
deleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.DeleteExportRequestResponse
deleteExportRequest(DeleteExportRequestRequest request)
Delete export object request using the specified identifier.DeleteExternalPublicationResponse
deleteExternalPublication(DeleteExternalPublicationRequest request)
Removes a published object using the specified identifier.DeleteExternalPublicationValidationResponse
deleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest request)
Removes a task validation using the specified identifier.DeleteFolderResponse
deleteFolder(DeleteFolderRequest request)
Removes a folder from a project using the specified identifier.DeleteFunctionLibraryResponse
deleteFunctionLibrary(DeleteFunctionLibraryRequest request)
Removes a Function Library from a project using the specified identifier.DeleteImportRequestResponse
deleteImportRequest(DeleteImportRequestRequest request)
Delete import object request using the specified identifier.DeletePatchResponse
deletePatch(DeletePatchRequest request)
Removes a patch using the specified identifier.DeletePipelineResponse
deletePipeline(DeletePipelineRequest request)
Removes a pipeline from a project or folder using the specified identifier.DeletePipelineValidationResponse
deletePipelineValidation(DeletePipelineValidationRequest request)
Removes a pipeline validation using the specified identifier.DeleteProjectResponse
deleteProject(DeleteProjectRequest request)
Removes a project from the workspace using the specified identifier.DeleteScheduleResponse
deleteSchedule(DeleteScheduleRequest request)
Endpoint to delete schedule.DeleteTaskResponse
deleteTask(DeleteTaskRequest request)
Removes a task using the specified identifier.DeleteTaskRunResponse
deleteTaskRun(DeleteTaskRunRequest request)
Deletes a task run using the specified identifier.DeleteTaskScheduleResponse
deleteTaskSchedule(DeleteTaskScheduleRequest request)
Endpoint to delete TaskSchedule.DeleteTaskValidationResponse
deleteTaskValidation(DeleteTaskValidationRequest request)
Removes a task validation using the specified identifier.DeleteUserDefinedFunctionResponse
deleteUserDefinedFunction(DeleteUserDefinedFunctionRequest request)
Removes a UserDefinedFunction from a function library using the specified identifier.DeleteUserDefinedFunctionValidationResponse
deleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest request)
Removes a UserDefinedFunction validation using the specified identifier.DeleteWorkspaceResponse
deleteWorkspace(DeleteWorkspaceRequest request)
Deletes a Data Integration workspace resource using the specified identifier.GetApplicationResponse
getApplication(GetApplicationRequest request)
Retrieves an application using the specified identifier.GetApplicationDetailedDescriptionResponse
getApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an ApplicationGetCompositeStateResponse
getCompositeState(GetCompositeStateRequest request)
This endpoint can be used to get composite state for a given aggregatorGetConnectionResponse
getConnection(GetConnectionRequest request)
Retrieves the connection details using the specified identifier.GetConnectionValidationResponse
getConnectionValidation(GetConnectionValidationRequest request)
Retrieves a connection validation using the specified identifier.GetCopyObjectRequestResponse
getCopyObjectRequest(GetCopyObjectRequestRequest request)
This endpoint can be used to get the summary/details of object being copied.GetCountStatisticResponse
getCountStatistic(GetCountStatisticRequest request)
Retrieves statistics on a workspace.GetDataAssetResponse
getDataAsset(GetDataAssetRequest request)
Retrieves details of a data asset using the specified identifier.GetDataEntityResponse
getDataEntity(GetDataEntityRequest request)
Retrieves the data entity details with the given name from live schema.GetDataFlowResponse
getDataFlow(GetDataFlowRequest request)
Retrieves a data flow using the specified identifier.GetDataFlowValidationResponse
getDataFlowValidation(GetDataFlowValidationRequest request)
Retrieves a data flow validation using the specified identifier.GetDependentObjectResponse
getDependentObject(GetDependentObjectRequest request)
Retrieves the details of a dependent object from an application.GetDisApplicationResponse
getDisApplication(GetDisApplicationRequest request)
Retrieves an application using the specified OCID.GetDisApplicationDetailedDescriptionResponse
getDisApplicationDetailedDescription(GetDisApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an Application.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)GetExportRequestResponse
getExportRequest(GetExportRequestRequest request)
This endpoint can be used to get the summary/details of object being exported.GetExternalPublicationResponse
getExternalPublication(GetExternalPublicationRequest request)
Retrieves a publshed object in an task using the specified identifier.GetExternalPublicationValidationResponse
getExternalPublicationValidation(GetExternalPublicationValidationRequest request)
Retrieves an external publication validation using the specified identifier.GetFolderResponse
getFolder(GetFolderRequest request)
Retrieves a folder using the specified identifier.GetFunctionLibraryResponse
getFunctionLibrary(GetFunctionLibraryRequest request)
Retrieves a Function Library using the specified identifier.GetImportRequestResponse
getImportRequest(GetImportRequestRequest request)
This endpoint can be used to get the summary/details of object being imported.DataIntegrationPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPatchResponse
getPatch(GetPatchRequest request)
Retrieves a patch in an application using the specified identifier.GetPipelineResponse
getPipeline(GetPipelineRequest request)
Retrieves a pipeline using the specified identifier.GetPipelineValidationResponse
getPipelineValidation(GetPipelineValidationRequest request)
Retrieves a pipeline validation using the specified identifier.GetProjectResponse
getProject(GetProjectRequest request)
Retrieves a project using the specified identifier.GetPublishedObjectResponse
getPublishedObject(GetPublishedObjectRequest request)
Retrieves the details of a published object from an application.GetReferenceResponse
getReference(GetReferenceRequest request)
Retrieves a reference in an application.GetRuntimeOperatorResponse
getRuntimeOperator(GetRuntimeOperatorRequest request)
Retrieves a runtime operator using the specified identifier.GetRuntimePipelineResponse
getRuntimePipeline(GetRuntimePipelineRequest request)
Retrieves a runtime pipeline using the specified identifier.GetScheduleResponse
getSchedule(GetScheduleRequest request)
Retrieves schedule by schedule keyGetSchemaResponse
getSchema(GetSchemaRequest request)
Retrieves a schema that can be accessed using the specified connection.GetTaskResponse
getTask(GetTaskRequest request)
Retrieves a task using the specified identifier.GetTaskRunResponse
getTaskRun(GetTaskRunRequest request)
Retrieves a task run using the specified identifier.GetTaskScheduleResponse
getTaskSchedule(GetTaskScheduleRequest request)
Endpoint used to get taskSchedule by its keyGetTaskValidationResponse
getTaskValidation(GetTaskValidationRequest request)
Retrieves a task validation using the specified identifier.GetTemplateResponse
getTemplate(GetTemplateRequest request)
This endpoint can be used to get an application template using a key.GetUserDefinedFunctionResponse
getUserDefinedFunction(GetUserDefinedFunctionRequest request)
Retrieves a UserDefinedFunction using the specified identifier.GetUserDefinedFunctionValidationResponse
getUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest request)
Retrieves a UserDefinedFunction validation using the specified identifier.DataIntegrationWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Retrieves the status of the work request with the given ID.GetWorkspaceResponse
getWorkspace(GetWorkspaceRequest request)
Retrieves a Data Integration workspace using the specified identifier.ListApplicationsResponse
listApplications(ListApplicationsRequest request)
Retrieves a list of applications and provides options to filter the list.ListConnectionsResponse
listConnections(ListConnectionsRequest request)
Retrieves a list of all connections.ListConnectionValidationsResponse
listConnectionValidations(ListConnectionValidationsRequest request)
Retrieves a list of connection validations within the specified workspace.ListCopyObjectRequestsResponse
listCopyObjectRequests(ListCopyObjectRequestsRequest request)
This endpoint can be used to get the list of copy object requests.ListDataAssetsResponse
listDataAssets(ListDataAssetsRequest request)
Retrieves a list of all data asset summaries.ListDataEntitiesResponse
listDataEntities(ListDataEntitiesRequest request)
Lists a summary of data entities from the data asset using the specified connection.ListDataFlowsResponse
listDataFlows(ListDataFlowsRequest request)
Retrieves a list of data flows in a project or folder.ListDataFlowValidationsResponse
listDataFlowValidations(ListDataFlowValidationsRequest request)
Retrieves a list of data flow validations within the specified workspace.ListDependentObjectsResponse
listDependentObjects(ListDependentObjectsRequest request)
Retrieves a list of all dependent objects for a specific application.ListDisApplicationsResponse
listDisApplications(ListDisApplicationsRequest request)
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.ListDisApplicationTaskRunLineagesResponse
listDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.ListExportRequestsResponse
listExportRequests(ListExportRequestsRequest request)
This endpoint can be used to get the list of export object requests.ListExternalPublicationsResponse
listExternalPublications(ListExternalPublicationsRequest request)
Retrieves a list of external publications in an application and provides options to filter the list.ListExternalPublicationValidationsResponse
listExternalPublicationValidations(ListExternalPublicationValidationsRequest request)
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.ListFoldersResponse
listFolders(ListFoldersRequest request)
Retrieves a list of folders in a project and provides options to filter the list.ListFunctionLibrariesResponse
listFunctionLibraries(ListFunctionLibrariesRequest request)
Retrieves a list of function libraries in a project and provides options to filter the list.ListImportRequestsResponse
listImportRequests(ListImportRequestsRequest request)
This endpoint can be used to get the list of import object requests.ListPatchChangesResponse
listPatchChanges(ListPatchChangesRequest request)
Retrieves a list of patches in an application and provides options to filter the list.ListPatchesResponse
listPatches(ListPatchesRequest request)
Retrieves a list of patches in an application and provides options to filter the list.ListPipelinesResponse
listPipelines(ListPipelinesRequest request)
Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.ListPipelineValidationsResponse
listPipelineValidations(ListPipelineValidationsRequest request)
Retrieves a list of pipeline validations within the specified workspace.ListProjectsResponse
listProjects(ListProjectsRequest request)
Retrieves a lists of projects in a workspace and provides options to filter the list.ListPublishedObjectsResponse
listPublishedObjects(ListPublishedObjectsRequest request)
Retrieves a list of all the published objects for a specified application.ListReferencesResponse
listReferences(ListReferencesRequest request)
Retrieves a list of references in an application.ListRuntimeOperatorsResponse
listRuntimeOperators(ListRuntimeOperatorsRequest request)
This endpoint can be used to list runtime operators with filtering optionsListRuntimePipelinesResponse
listRuntimePipelines(ListRuntimePipelinesRequest request)
This endpoint can be used to list runtime pipelines with filtering optionsListSchedulesResponse
listSchedules(ListSchedulesRequest request)
Use this endpoint to list schedules.ListSchemasResponse
listSchemas(ListSchemasRequest request)
Retrieves a list of all the schemas that can be accessed using the specified connection.ListTaskRunLineagesResponse
listTaskRunLineages(ListTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.ListTaskRunLogsResponse
listTaskRunLogs(ListTaskRunLogsRequest request)
Gets log entries for task runs using its key.ListTaskRunsResponse
listTaskRuns(ListTaskRunsRequest request)
Retrieves a list of task runs and provides options to filter the list.ListTasksResponse
listTasks(ListTasksRequest request)
Retrieves a list of all tasks in a specified project or folder.ListTaskSchedulesResponse
listTaskSchedules(ListTaskSchedulesRequest request)
This endpoint can be used to get the list of all the TaskSchedule objects.ListTaskValidationsResponse
listTaskValidations(ListTaskValidationsRequest request)
Retrieves a list of task validations within the specified workspace.ListTemplatesResponse
listTemplates(ListTemplatesRequest request)
This endpoint can be used to list application templates with filtering options.ListUserDefinedFunctionsResponse
listUserDefinedFunctions(ListUserDefinedFunctionsRequest request)
Retrieves a list of UserDefinedFunctions in a function library.ListUserDefinedFunctionValidationsResponse
listUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest request)
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Retrieves a paginated list of errors for a given work request.ListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Retrieves a paginated list of logs for a given work request.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.ListWorkspacesResponse
listWorkspaces(ListWorkspacesRequest request)
Retrieves a list of Data Integration workspaces.void
refreshClient()
Rebuilds the client from scratch.void
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).StartWorkspaceResponse
startWorkspace(StartWorkspaceRequest request)
Starts a workspace.StopWorkspaceResponse
stopWorkspace(StopWorkspaceRequest request)
Stops a workspace.UpdateApplicationResponse
updateApplication(UpdateApplicationRequest request)
Updates an application.UpdateApplicationDetailedDescriptionResponse
updateApplicationDetailedDescription(UpdateApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.UpdateConnectionResponse
updateConnection(UpdateConnectionRequest request)
Updates a connection under a data asset.UpdateCopyObjectRequestResponse
updateCopyObjectRequest(UpdateCopyObjectRequestRequest request)
Updates the status of a copy object request.UpdateDataAssetResponse
updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset with default connection.UpdateDataFlowResponse
updateDataFlow(UpdateDataFlowRequest request)
Updates a specific data flow.UpdateDisApplicationResponse
updateDisApplication(UpdateDisApplicationRequest request)
Updates a DIS Application.UpdateDisApplicationDetailedDescriptionResponse
updateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.UpdateExportRequestResponse
updateExportRequest(UpdateExportRequestRequest request)
Updates the status of a export object request.UpdateExternalPublicationResponse
updateExternalPublication(UpdateExternalPublicationRequest request)
Updates the external publication object.UpdateFolderResponse
updateFolder(UpdateFolderRequest request)
Updates a specific folder.UpdateFunctionLibraryResponse
updateFunctionLibrary(UpdateFunctionLibraryRequest request)
Updates a specific Function Library.UpdateImportRequestResponse
updateImportRequest(UpdateImportRequestRequest request)
Updates the status of a import object request.UpdatePipelineResponse
updatePipeline(UpdatePipelineRequest request)
Updates a specific pipeline.UpdateProjectResponse
updateProject(UpdateProjectRequest request)
Updates a specific project.UpdateReferenceResponse
updateReference(UpdateReferenceRequest request)
Updates the application references.UpdateScheduleResponse
updateSchedule(UpdateScheduleRequest request)
Endpoint used to update the scheduleUpdateTaskResponse
updateTask(UpdateTaskRequest request)
Updates a specific task.UpdateTaskRunResponse
updateTaskRun(UpdateTaskRunRequest request)
Updates the status of the task run.UpdateTaskScheduleResponse
updateTaskSchedule(UpdateTaskScheduleRequest request)
Endpoint used to update the TaskScheduleUpdateUserDefinedFunctionResponse
updateUserDefinedFunction(UpdateUserDefinedFunctionRequest request)
Updates a specific UserDefinedFunction.UpdateWorkspaceResponse
updateWorkspace(UpdateWorkspaceRequest request)
Updates the specified Data Integration workspace.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Parameters:
region
- The region of the service.
-
setRegion
void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
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
- flag to enable the use of realm specific endpoint template
-
changeCompartment
ChangeCompartmentResponse changeCompartment(ChangeCompartmentRequest request)
Moves a workspace to a specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ChangeCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeCompartment API.
-
changeDisApplicationCompartment
ChangeDisApplicationCompartmentResponse changeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest request)
Moves a DIS Application to a specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ChangeDisApplicationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDisApplicationCompartment API.
-
createApplication
CreateApplicationResponse createApplication(CreateApplicationRequest request)
Creates an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateApplication API.
-
createApplicationDetailedDescription
CreateApplicationDetailedDescriptionResponse createApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateApplicationDetailedDescription API.
-
createConnection
CreateConnectionResponse createConnection(CreateConnectionRequest request)
Creates a connection under an existing data asset.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConnection API.
-
createConnectionValidation
CreateConnectionValidationResponse createConnectionValidation(CreateConnectionValidationRequest request)
Creates a connection validation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateConnectionValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConnectionValidation API.
-
createCopyObjectRequest
CreateCopyObjectRequestResponse createCopyObjectRequest(CreateCopyObjectRequestRequest request)
Copy Metadata Object.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateCopyObjectRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCopyObjectRequest API.
-
createDataAsset
CreateDataAssetResponse createDataAsset(CreateDataAssetRequest request)
Creates a data asset with default connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDataAsset API.
-
createDataFlow
CreateDataFlowResponse createDataFlow(CreateDataFlowRequest request)
Creates a new data flow in a project or folder ready for performing data integrations.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateDataFlowExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDataFlow API.
-
createDataFlowValidation
CreateDataFlowValidationResponse createDataFlowValidation(CreateDataFlowValidationRequest request)
Accepts the data flow definition in the request payload and creates a data flow validation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateDataFlowValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDataFlowValidation API.
-
createDisApplication
CreateDisApplicationResponse createDisApplication(CreateDisApplicationRequest request)
Creates a DIS Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateDisApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDisApplication API.
-
createDisApplicationDetailedDescription
CreateDisApplicationDetailedDescriptionResponse createDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateDisApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDisApplicationDetailedDescription API.
-
createEntityShape
CreateEntityShapeResponse createEntityShape(CreateEntityShapeRequest request)
Creates the data entity shape using the shape from the data asset.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateEntityShapeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEntityShape API.
-
createExportRequest
CreateExportRequestResponse createExportRequest(CreateExportRequestRequest request)
Export Metadata Object- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateExportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateExportRequest API.
-
createExternalPublication
CreateExternalPublicationResponse createExternalPublication(CreateExternalPublicationRequest request)
Publish a DataFlow in a OCI DataFlow application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateExternalPublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateExternalPublication API.
-
createExternalPublicationValidation
CreateExternalPublicationValidationResponse createExternalPublicationValidation(CreateExternalPublicationValidationRequest request)
Validates a specific task.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateExternalPublicationValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateExternalPublicationValidation API.
-
createFolder
CreateFolderResponse createFolder(CreateFolderRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFolder API.
-
createFunctionLibrary
CreateFunctionLibraryResponse createFunctionLibrary(CreateFunctionLibraryRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateFunctionLibraryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateFunctionLibrary API.
-
createImportRequest
CreateImportRequestResponse createImportRequest(CreateImportRequestRequest request)
Import Metadata Object- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateImportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateImportRequest API.
-
createPatch
CreatePatchResponse createPatch(CreatePatchRequest request)
Creates a patch in an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreatePatchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePatch API.
-
createPipeline
CreatePipelineResponse createPipeline(CreatePipelineRequest request)
Creates a new pipeline in a project or folder ready for performing task orchestration.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreatePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePipeline API.
-
createPipelineValidation
CreatePipelineValidationResponse createPipelineValidation(CreatePipelineValidationRequest request)
Accepts the data flow definition in the request payload and creates a pipeline validation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreatePipelineValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePipelineValidation API.
-
createProject
CreateProjectResponse createProject(CreateProjectRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateProject API.
-
createSchedule
CreateScheduleResponse createSchedule(CreateScheduleRequest request)
Endpoint to create a new schedule- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSchedule API.
-
createTask
CreateTaskResponse createTask(CreateTaskRequest request)
Creates a new task ready for performing data integrations.There are specialized types of tasks that include data loader and integration tasks.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTask API.
-
createTaskRun
CreateTaskRunResponse createTaskRun(CreateTaskRunRequest request)
Creates a data integration task run for the specified task.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateTaskRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTaskRun API.
-
createTaskSchedule
CreateTaskScheduleResponse createTaskSchedule(CreateTaskScheduleRequest request)
Endpoint to be used create TaskSchedule.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateTaskScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTaskSchedule API.
-
createTaskValidation
CreateTaskValidationResponse createTaskValidation(CreateTaskValidationRequest request)
Validates a specific task.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateTaskValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateTaskValidation API.
-
createUserDefinedFunction
CreateUserDefinedFunctionResponse createUserDefinedFunction(CreateUserDefinedFunctionRequest request)
Creates a new UserDefinedFunction in a function library ready for performing data integrations.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateUserDefinedFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateUserDefinedFunction API.
-
createUserDefinedFunctionValidation
CreateUserDefinedFunctionValidationResponse createUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest request)
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateUserDefinedFunctionValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateUserDefinedFunctionValidation API.
-
createWorkspace
CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest request)
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
getWorkRequest
API.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/CreateWorkspaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateWorkspace API.
-
deleteApplication
DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)
Removes an application using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteApplication API.
-
deleteApplicationDetailedDescription
DeleteApplicationDetailedDescriptionResponse deleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteApplicationDetailedDescription API.
-
deleteConnection
DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Removes a connection using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConnection API.
-
deleteConnectionValidation
DeleteConnectionValidationResponse deleteConnectionValidation(DeleteConnectionValidationRequest request)
Deletes a connection validation.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteConnectionValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConnectionValidation API.
-
deleteCopyObjectRequest
DeleteCopyObjectRequestResponse deleteCopyObjectRequest(DeleteCopyObjectRequestRequest request)
Delete copy object request using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteCopyObjectRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCopyObjectRequest API.
-
deleteDataAsset
DeleteDataAssetResponse deleteDataAsset(DeleteDataAssetRequest request)
Removes a data asset using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDataAsset API.
-
deleteDataFlow
DeleteDataFlowResponse deleteDataFlow(DeleteDataFlowRequest request)
Removes a data flow from a project or folder using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteDataFlowExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDataFlow API.
-
deleteDataFlowValidation
DeleteDataFlowValidationResponse deleteDataFlowValidation(DeleteDataFlowValidationRequest request)
Removes a data flow validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteDataFlowValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDataFlowValidation API.
-
deleteDisApplication
DeleteDisApplicationResponse deleteDisApplication(DeleteDisApplicationRequest request)
Removes a DIS application using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteDisApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDisApplication API.
-
deleteDisApplicationDetailedDescription
DeleteDisApplicationDetailedDescriptionResponse deleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteDisApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDisApplicationDetailedDescription API.
-
deleteExportRequest
DeleteExportRequestResponse deleteExportRequest(DeleteExportRequestRequest request)
Delete export object request using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteExportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteExportRequest API.
-
deleteExternalPublication
DeleteExternalPublicationResponse deleteExternalPublication(DeleteExternalPublicationRequest request)
Removes a published object using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteExternalPublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteExternalPublication API.
-
deleteExternalPublicationValidation
DeleteExternalPublicationValidationResponse deleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest request)
Removes a task validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteExternalPublicationValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteExternalPublicationValidation API.
-
deleteFolder
DeleteFolderResponse deleteFolder(DeleteFolderRequest request)
Removes a folder from a project using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFolder API.
-
deleteFunctionLibrary
DeleteFunctionLibraryResponse deleteFunctionLibrary(DeleteFunctionLibraryRequest request)
Removes a Function Library from a project using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteFunctionLibraryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteFunctionLibrary API.
-
deleteImportRequest
DeleteImportRequestResponse deleteImportRequest(DeleteImportRequestRequest request)
Delete import object request using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteImportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteImportRequest API.
-
deletePatch
DeletePatchResponse deletePatch(DeletePatchRequest request)
Removes a patch using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeletePatchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePatch API.
-
deletePipeline
DeletePipelineResponse deletePipeline(DeletePipelineRequest request)
Removes a pipeline from a project or folder using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeletePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePipeline API.
-
deletePipelineValidation
DeletePipelineValidationResponse deletePipelineValidation(DeletePipelineValidationRequest request)
Removes a pipeline validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeletePipelineValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePipelineValidation API.
-
deleteProject
DeleteProjectResponse deleteProject(DeleteProjectRequest request)
Removes a project from the workspace using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteProject API.
-
deleteSchedule
DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)
Endpoint to delete schedule.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSchedule API.
-
deleteTask
DeleteTaskResponse deleteTask(DeleteTaskRequest request)
Removes a task using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTask API.
-
deleteTaskRun
DeleteTaskRunResponse deleteTaskRun(DeleteTaskRunRequest request)
Deletes a task run using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteTaskRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTaskRun API.
-
deleteTaskSchedule
DeleteTaskScheduleResponse deleteTaskSchedule(DeleteTaskScheduleRequest request)
Endpoint to delete TaskSchedule.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteTaskScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTaskSchedule API.
-
deleteTaskValidation
DeleteTaskValidationResponse deleteTaskValidation(DeleteTaskValidationRequest request)
Removes a task validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteTaskValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteTaskValidation API.
-
deleteUserDefinedFunction
DeleteUserDefinedFunctionResponse deleteUserDefinedFunction(DeleteUserDefinedFunctionRequest request)
Removes a UserDefinedFunction from a function library using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteUserDefinedFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUserDefinedFunction API.
-
deleteUserDefinedFunctionValidation
DeleteUserDefinedFunctionValidationResponse deleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest request)
Removes a UserDefinedFunction validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteUserDefinedFunctionValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteUserDefinedFunctionValidation API.
-
deleteWorkspace
DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest request)
Deletes a Data Integration workspace resource using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/DeleteWorkspaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteWorkspace API.
-
getApplication
GetApplicationResponse getApplication(GetApplicationRequest request)
Retrieves an application using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetApplication API.
-
getApplicationDetailedDescription
GetApplicationDetailedDescriptionResponse getApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an Application- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetApplicationDetailedDescription API.
-
getCompositeState
GetCompositeStateResponse getCompositeState(GetCompositeStateRequest request)
This endpoint can be used to get composite state for a given aggregator- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetCompositeStateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCompositeState API.
-
getConnection
GetConnectionResponse getConnection(GetConnectionRequest request)
Retrieves the connection details using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnection API.
-
getConnectionValidation
GetConnectionValidationResponse getConnectionValidation(GetConnectionValidationRequest request)
Retrieves a connection validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetConnectionValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnectionValidation API.
-
getCopyObjectRequest
GetCopyObjectRequestResponse getCopyObjectRequest(GetCopyObjectRequestRequest request)
This endpoint can be used to get the summary/details of object being copied.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetCopyObjectRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCopyObjectRequest API.
-
getCountStatistic
GetCountStatisticResponse getCountStatistic(GetCountStatisticRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetCountStatisticExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCountStatistic API.
-
getDataAsset
GetDataAssetResponse getDataAsset(GetDataAssetRequest request)
Retrieves details of a data asset using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataAsset API.
-
getDataEntity
GetDataEntityResponse getDataEntity(GetDataEntityRequest request)
Retrieves the data entity details with the given name from live schema.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDataEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataEntity API.
-
getDataFlow
GetDataFlowResponse getDataFlow(GetDataFlowRequest request)
Retrieves a data flow using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDataFlowExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataFlow API.
-
getDataFlowValidation
GetDataFlowValidationResponse getDataFlowValidation(GetDataFlowValidationRequest request)
Retrieves a data flow validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDataFlowValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDataFlowValidation API.
-
getDependentObject
GetDependentObjectResponse getDependentObject(GetDependentObjectRequest request)
Retrieves the details of a dependent object from an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDependentObjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDependentObject API.
-
getDisApplication
GetDisApplicationResponse getDisApplication(GetDisApplicationRequest request)
Retrieves an application using the specified OCID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDisApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDisApplication API.
-
getDisApplicationDetailedDescription
GetDisApplicationDetailedDescriptionResponse getDisApplicationDetailedDescription(GetDisApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetDisApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDisApplicationDetailedDescription API.
-
getExportRequest
GetExportRequestResponse getExportRequest(GetExportRequestRequest request)
This endpoint can be used to get the summary/details of object being exported.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetExportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetExportRequest API.
-
getExternalPublication
GetExternalPublicationResponse getExternalPublication(GetExternalPublicationRequest request)
Retrieves a publshed object in an task using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetExternalPublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetExternalPublication API.
-
getExternalPublicationValidation
GetExternalPublicationValidationResponse getExternalPublicationValidation(GetExternalPublicationValidationRequest request)
Retrieves an external publication validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetExternalPublicationValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetExternalPublicationValidation API.
-
getFolder
GetFolderResponse getFolder(GetFolderRequest request)
Retrieves a folder using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFolder API.
-
getFunctionLibrary
GetFunctionLibraryResponse getFunctionLibrary(GetFunctionLibraryRequest request)
Retrieves a Function Library using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetFunctionLibraryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetFunctionLibrary API.
-
getImportRequest
GetImportRequestResponse getImportRequest(GetImportRequestRequest request)
This endpoint can be used to get the summary/details of object being imported.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetImportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetImportRequest API.
-
getPatch
GetPatchResponse getPatch(GetPatchRequest request)
Retrieves a patch in an application using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetPatchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPatch API.
-
getPipeline
GetPipelineResponse getPipeline(GetPipelineRequest request)
Retrieves a pipeline using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPipeline API.
-
getPipelineValidation
GetPipelineValidationResponse getPipelineValidation(GetPipelineValidationRequest request)
Retrieves a pipeline validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetPipelineValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPipelineValidation API.
-
getProject
GetProjectResponse getProject(GetProjectRequest request)
Retrieves a project using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProject API.
-
getPublishedObject
GetPublishedObjectResponse getPublishedObject(GetPublishedObjectRequest request)
Retrieves the details of a published object from an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetPublishedObjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPublishedObject API.
-
getReference
GetReferenceResponse getReference(GetReferenceRequest request)
Retrieves a reference in an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetReferenceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetReference API.
-
getRuntimeOperator
GetRuntimeOperatorResponse getRuntimeOperator(GetRuntimeOperatorRequest request)
Retrieves a runtime operator using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetRuntimeOperatorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRuntimeOperator API.
-
getRuntimePipeline
GetRuntimePipelineResponse getRuntimePipeline(GetRuntimePipelineRequest request)
Retrieves a runtime pipeline using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetRuntimePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRuntimePipeline API.
-
getSchedule
GetScheduleResponse getSchedule(GetScheduleRequest request)
Retrieves schedule by schedule key- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSchedule API.
-
getSchema
GetSchemaResponse getSchema(GetSchemaRequest request)
Retrieves a schema that can be accessed using the specified connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetSchemaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSchema API.
-
getTask
GetTaskResponse getTask(GetTaskRequest request)
Retrieves a task using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTask API.
-
getTaskRun
GetTaskRunResponse getTaskRun(GetTaskRunRequest request)
Retrieves a task run using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetTaskRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTaskRun API.
-
getTaskSchedule
GetTaskScheduleResponse getTaskSchedule(GetTaskScheduleRequest request)
Endpoint used to get taskSchedule by its key- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetTaskScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTaskSchedule API.
-
getTaskValidation
GetTaskValidationResponse getTaskValidation(GetTaskValidationRequest request)
Retrieves a task validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetTaskValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTaskValidation API.
-
getTemplate
GetTemplateResponse getTemplate(GetTemplateRequest request)
This endpoint can be used to get an application template using a key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetTemplateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTemplate API.
-
getUserDefinedFunction
GetUserDefinedFunctionResponse getUserDefinedFunction(GetUserDefinedFunctionRequest request)
Retrieves a UserDefinedFunction using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetUserDefinedFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUserDefinedFunction API.
-
getUserDefinedFunctionValidation
GetUserDefinedFunctionValidationResponse getUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest request)
Retrieves a UserDefinedFunction validation using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetUserDefinedFunctionValidationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetUserDefinedFunctionValidation API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Retrieves the status of the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
getWorkspace
GetWorkspaceResponse getWorkspace(GetWorkspaceRequest request)
Retrieves a Data Integration workspace using the specified identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/GetWorkspaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkspace API.
-
listApplications
ListApplicationsResponse listApplications(ListApplicationsRequest request)
Retrieves a list of applications and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListApplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListApplications API.
-
listConnectionValidations
ListConnectionValidationsResponse listConnectionValidations(ListConnectionValidationsRequest request)
Retrieves a list of connection validations within the specified workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListConnectionValidationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConnectionValidations API.
-
listConnections
ListConnectionsResponse listConnections(ListConnectionsRequest request)
Retrieves a list of all connections.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListConnectionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConnections API.
-
listCopyObjectRequests
ListCopyObjectRequestsResponse listCopyObjectRequests(ListCopyObjectRequestsRequest request)
This endpoint can be used to get the list of copy object requests.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListCopyObjectRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCopyObjectRequests API.
-
listDataAssets
ListDataAssetsResponse listDataAssets(ListDataAssetsRequest request)
Retrieves a list of all data asset summaries.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDataAssetsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataAssets API.
-
listDataEntities
ListDataEntitiesResponse listDataEntities(ListDataEntitiesRequest request)
Lists a summary of data entities from the data asset using the specified connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDataEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataEntities API.
-
listDataFlowValidations
ListDataFlowValidationsResponse listDataFlowValidations(ListDataFlowValidationsRequest request)
Retrieves a list of data flow validations within the specified workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDataFlowValidationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataFlowValidations API.
-
listDataFlows
ListDataFlowsResponse listDataFlows(ListDataFlowsRequest request)
Retrieves a list of data flows in a project or folder.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDataFlowsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDataFlows API.
-
listDependentObjects
ListDependentObjectsResponse listDependentObjects(ListDependentObjectsRequest request)
Retrieves a list of all dependent objects for a specific application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDependentObjectsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDependentObjects API.
-
listDisApplicationTaskRunLineages
ListDisApplicationTaskRunLineagesResponse listDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDisApplicationTaskRunLineagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDisApplicationTaskRunLineages API.
-
listDisApplications
ListDisApplicationsResponse listDisApplications(ListDisApplicationsRequest request)
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListDisApplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDisApplications API.
-
listExportRequests
ListExportRequestsResponse listExportRequests(ListExportRequestsRequest request)
This endpoint can be used to get the list of export object requests.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListExportRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExportRequests API.
-
listExternalPublicationValidations
ListExternalPublicationValidationsResponse listExternalPublicationValidations(ListExternalPublicationValidationsRequest request)
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListExternalPublicationValidationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExternalPublicationValidations API.
-
listExternalPublications
ListExternalPublicationsResponse listExternalPublications(ListExternalPublicationsRequest request)
Retrieves a list of external publications in an application and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListExternalPublicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListExternalPublications API.
-
listFolders
ListFoldersResponse listFolders(ListFoldersRequest request)
Retrieves a list of folders in a project and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListFoldersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFolders API.
-
listFunctionLibraries
ListFunctionLibrariesResponse listFunctionLibraries(ListFunctionLibrariesRequest request)
Retrieves a list of function libraries in a project and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListFunctionLibrariesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFunctionLibraries API.
-
listImportRequests
ListImportRequestsResponse listImportRequests(ListImportRequestsRequest request)
This endpoint can be used to get the list of import object requests.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListImportRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListImportRequests API.
-
listPatchChanges
ListPatchChangesResponse listPatchChanges(ListPatchChangesRequest request)
Retrieves a list of patches in an application and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListPatchChangesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPatchChanges API.
-
listPatches
ListPatchesResponse listPatches(ListPatchesRequest request)
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListPatchesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPatches API.
-
listPipelineValidations
ListPipelineValidationsResponse listPipelineValidations(ListPipelineValidationsRequest request)
Retrieves a list of pipeline validations within the specified workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListPipelineValidationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelineValidations API.
-
listPipelines
ListPipelinesResponse listPipelines(ListPipelinesRequest request)
Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListPipelinesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelines API.
-
listProjects
ListProjectsResponse listProjects(ListProjectsRequest request)
Retrieves a lists of projects in a workspace and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListProjectsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProjects API.
-
listPublishedObjects
ListPublishedObjectsResponse listPublishedObjects(ListPublishedObjectsRequest request)
Retrieves a list of all the published objects for a specified application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListPublishedObjectsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPublishedObjects API.
-
listReferences
ListReferencesResponse listReferences(ListReferencesRequest request)
Retrieves a list of references in an application.Reference objects are created when dataflows and tasks use objects, such as data assets and connections.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListReferencesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListReferences API.
-
listRuntimeOperators
ListRuntimeOperatorsResponse listRuntimeOperators(ListRuntimeOperatorsRequest request)
This endpoint can be used to list runtime operators with filtering options- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListRuntimeOperatorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRuntimeOperators API.
-
listRuntimePipelines
ListRuntimePipelinesResponse listRuntimePipelines(ListRuntimePipelinesRequest request)
This endpoint can be used to list runtime pipelines with filtering options- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListRuntimePipelinesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRuntimePipelines API.
-
listSchedules
ListSchedulesResponse listSchedules(ListSchedulesRequest request)
Use this endpoint to list schedules.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListSchedulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSchedules API.
-
listSchemas
ListSchemasResponse listSchemas(ListSchemasRequest request)
Retrieves a list of all the schemas that can be accessed using the specified connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListSchemasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSchemas API.
-
listTaskRunLineages
ListTaskRunLineagesResponse listTaskRunLineages(ListTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTaskRunLineagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaskRunLineages API.
-
listTaskRunLogs
ListTaskRunLogsResponse listTaskRunLogs(ListTaskRunLogsRequest request)
Gets log entries for task runs using its key.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTaskRunLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaskRunLogs API.
-
listTaskRuns
ListTaskRunsResponse listTaskRuns(ListTaskRunsRequest request)
Retrieves a list of task runs and provides options to filter the list.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTaskRunsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaskRuns API.
-
listTaskSchedules
ListTaskSchedulesResponse listTaskSchedules(ListTaskSchedulesRequest request)
This endpoint can be used to get the list of all the TaskSchedule objects.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTaskSchedulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaskSchedules API.
-
listTaskValidations
ListTaskValidationsResponse listTaskValidations(ListTaskValidationsRequest request)
Retrieves a list of task validations within the specified workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTaskValidationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTaskValidations API.
-
listTasks
ListTasksResponse listTasks(ListTasksRequest request)
Retrieves a list of all tasks in a specified project or folder.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTasksExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTasks API.
-
listTemplates
ListTemplatesResponse listTemplates(ListTemplatesRequest request)
This endpoint can be used to list application templates with filtering options.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListTemplatesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTemplates API.
-
listUserDefinedFunctionValidations
ListUserDefinedFunctionValidationsResponse listUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest request)
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListUserDefinedFunctionValidationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUserDefinedFunctionValidations API.
-
listUserDefinedFunctions
ListUserDefinedFunctionsResponse listUserDefinedFunctions(ListUserDefinedFunctionsRequest request)
Retrieves a list of UserDefinedFunctions in a function library.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListUserDefinedFunctionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListUserDefinedFunctions API.
-
listWorkRequestErrors
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Retrieves a paginated list of errors for a given work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
-
listWorkRequestLogs
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Retrieves a paginated list of logs for a given work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
listWorkspaces
ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest request)
Retrieves a list of Data Integration workspaces.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/ListWorkspacesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkspaces API.
-
startWorkspace
StartWorkspaceResponse startWorkspace(StartWorkspaceRequest request)
Starts a workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/StartWorkspaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartWorkspace API.
-
stopWorkspace
StopWorkspaceResponse stopWorkspace(StopWorkspaceRequest request)
Stops a workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/StopWorkspaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopWorkspace API.
-
updateApplication
UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)
Updates an application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateApplication API.
-
updateApplicationDetailedDescription
UpdateApplicationDetailedDescriptionResponse updateApplicationDetailedDescription(UpdateApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateApplicationDetailedDescription API.
-
updateConnection
UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Updates a connection under a data asset.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateConnection API.
-
updateCopyObjectRequest
UpdateCopyObjectRequestResponse updateCopyObjectRequest(UpdateCopyObjectRequestRequest request)
Updates the status of a copy object request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateCopyObjectRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCopyObjectRequest API.
-
updateDataAsset
UpdateDataAssetResponse updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset with default connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateDataAssetExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDataAsset API.
-
updateDataFlow
UpdateDataFlowResponse updateDataFlow(UpdateDataFlowRequest request)
Updates a specific data flow.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateDataFlowExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDataFlow API.
-
updateDisApplication
UpdateDisApplicationResponse updateDisApplication(UpdateDisApplicationRequest request)
Updates a DIS Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateDisApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDisApplication API.
-
updateDisApplicationDetailedDescription
UpdateDisApplicationDetailedDescriptionResponse updateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateDisApplicationDetailedDescriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDisApplicationDetailedDescription API.
-
updateExportRequest
UpdateExportRequestResponse updateExportRequest(UpdateExportRequestRequest request)
Updates the status of a export object request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateExportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateExportRequest API.
-
updateExternalPublication
UpdateExternalPublicationResponse updateExternalPublication(UpdateExternalPublicationRequest request)
Updates the external publication object.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateExternalPublicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateExternalPublication API.
-
updateFolder
UpdateFolderResponse updateFolder(UpdateFolderRequest request)
Updates a specific folder.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateFolderExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateFolder API.
-
updateFunctionLibrary
UpdateFunctionLibraryResponse updateFunctionLibrary(UpdateFunctionLibraryRequest request)
Updates a specific Function Library.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateFunctionLibraryExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateFunctionLibrary API.
-
updateImportRequest
UpdateImportRequestResponse updateImportRequest(UpdateImportRequestRequest request)
Updates the status of a import object request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateImportRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateImportRequest API.
-
updatePipeline
UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request)
Updates a specific pipeline.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdatePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePipeline API.
-
updateProject
UpdateProjectResponse updateProject(UpdateProjectRequest request)
Updates a specific project.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateProject API.
-
updateReference
UpdateReferenceResponse updateReference(UpdateReferenceRequest request)
Updates the application references.For example, to map a data asset to a different target object.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateReferenceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateReference API.
-
updateSchedule
UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)
Endpoint used to update the schedule- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSchedule API.
-
updateTask
UpdateTaskResponse updateTask(UpdateTaskRequest request)
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.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateTaskExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTask API.
-
updateTaskRun
UpdateTaskRunResponse updateTaskRun(UpdateTaskRunRequest request)
Updates the status of the task run.For example, aborts a task run.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateTaskRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTaskRun API.
-
updateTaskSchedule
UpdateTaskScheduleResponse updateTaskSchedule(UpdateTaskScheduleRequest request)
Endpoint used to update the TaskSchedule- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateTaskScheduleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateTaskSchedule API.
-
updateUserDefinedFunction
UpdateUserDefinedFunctionResponse updateUserDefinedFunction(UpdateUserDefinedFunctionRequest request)
Updates a specific UserDefinedFunction.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateUserDefinedFunctionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateUserDefinedFunction API.
-
updateWorkspace
UpdateWorkspaceResponse updateWorkspace(UpdateWorkspaceRequest request)
Updates the specified Data Integration workspace.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataintegration/UpdateWorkspaceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateWorkspace API.
-
getWaiters
DataIntegrationWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
DataIntegrationPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Returns:
- The service paginators.
-
-