@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.
Modifier and Type | Method and 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 Object
|
CreateExternalPublicationResponse |
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 Object
|
CreatePatchResponse |
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 schedule
|
CreateTaskResponse |
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 Application
|
GetCompositeStateResponse |
getCompositeState(GetCompositeStateRequest request)
This endpoint can be used to get composite state for a given aggregator
|
GetConnectionResponse |
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 key
|
GetSchemaResponse |
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 key
|
GetTaskValidationResponse |
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 options
|
ListRuntimePipelinesResponse |
listRuntimePipelines(ListRuntimePipelinesRequest request)
This endpoint can be used to list runtime pipelines with filtering options
|
ListSchedulesResponse |
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 schedule
|
UpdateTaskResponse |
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 TaskSchedule
|
UpdateUserDefinedFunctionResponse |
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.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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 call setEndpoint
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateChangeCompartmentResponse changeCompartment(ChangeCompartmentRequest request)
Moves a workspace to a specified compartment.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ChangeCompartment API.
ChangeDisApplicationCompartmentResponse changeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest request)
Moves a DIS Application to a specified compartment.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ChangeDisApplicationCompartment API.
CreateApplicationResponse createApplication(CreateApplicationRequest request)
Creates an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateApplication API.
CreateApplicationDetailedDescriptionResponse createApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateApplicationDetailedDescription API.
CreateConnectionResponse createConnection(CreateConnectionRequest request)
Creates a connection under an existing data asset.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateConnection API.
CreateConnectionValidationResponse createConnectionValidation(CreateConnectionValidationRequest request)
Creates a connection validation.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateConnectionValidation API.
CreateCopyObjectRequestResponse createCopyObjectRequest(CreateCopyObjectRequestRequest request)
Copy Metadata Object.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateCopyObjectRequest API.
CreateDataAssetResponse createDataAsset(CreateDataAssetRequest request)
Creates a data asset with default connection.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateDataAsset API.
CreateDataFlowResponse createDataFlow(CreateDataFlowRequest request)
Creates a new data flow in a project or folder ready for performing data integrations.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateDataFlow API.
CreateDataFlowValidationResponse createDataFlowValidation(CreateDataFlowValidationRequest request)
Accepts the data flow definition in the request payload and creates a data flow validation.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateDataFlowValidation API.
CreateDisApplicationResponse createDisApplication(CreateDisApplicationRequest request)
Creates a DIS Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateDisApplication API.
CreateDisApplicationDetailedDescriptionResponse createDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateDisApplicationDetailedDescription API.
CreateEntityShapeResponse createEntityShape(CreateEntityShapeRequest request)
Creates the data entity shape using the shape from the data asset.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateEntityShape API.
CreateExportRequestResponse createExportRequest(CreateExportRequestRequest request)
Export Metadata Object
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateExportRequest API.
CreateExternalPublicationResponse createExternalPublication(CreateExternalPublicationRequest request)
Publish a DataFlow in a OCI DataFlow application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateExternalPublication API.
CreateExternalPublicationValidationResponse createExternalPublicationValidation(CreateExternalPublicationValidationRequest request)
Validates a specific task.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateExternalPublicationValidation API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateFolder API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateFunctionLibrary API.
CreateImportRequestResponse createImportRequest(CreateImportRequestRequest request)
Import Metadata Object
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateImportRequest API.
CreatePatchResponse createPatch(CreatePatchRequest request)
Creates a patch in an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreatePatch API.
CreatePipelineResponse createPipeline(CreatePipelineRequest request)
Creates a new pipeline in a project or folder ready for performing task orchestration.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreatePipeline API.
CreatePipelineValidationResponse createPipelineValidation(CreatePipelineValidationRequest request)
Accepts the data flow definition in the request payload and creates a pipeline validation.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreatePipelineValidation API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateProject API.
CreateScheduleResponse createSchedule(CreateScheduleRequest request)
Endpoint to create a new schedule
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateSchedule API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateTask API.
CreateTaskRunResponse createTaskRun(CreateTaskRunRequest request)
Creates a data integration task run for the specified task.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateTaskRun API.
CreateTaskScheduleResponse createTaskSchedule(CreateTaskScheduleRequest request)
Endpoint to be used create TaskSchedule.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateTaskSchedule API.
CreateTaskValidationResponse createTaskValidation(CreateTaskValidationRequest request)
Validates a specific task.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateTaskValidation API.
CreateUserDefinedFunctionResponse createUserDefinedFunction(CreateUserDefinedFunctionRequest request)
Creates a new UserDefinedFunction in a function library ready for performing data integrations.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateUserDefinedFunction API.
CreateUserDefinedFunctionValidationResponse createUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest request)
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateUserDefinedFunctionValidation API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use CreateWorkspace API.
DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)
Removes an application using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteApplication API.
DeleteApplicationDetailedDescriptionResponse deleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteApplicationDetailedDescription API.
DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Removes a connection using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteConnection API.
DeleteConnectionValidationResponse deleteConnectionValidation(DeleteConnectionValidationRequest request)
Deletes a connection validation.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteConnectionValidation API.
DeleteCopyObjectRequestResponse deleteCopyObjectRequest(DeleteCopyObjectRequestRequest request)
Delete copy object request using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteCopyObjectRequest API.
DeleteDataAssetResponse deleteDataAsset(DeleteDataAssetRequest request)
Removes a data asset using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteDataAsset API.
DeleteDataFlowResponse deleteDataFlow(DeleteDataFlowRequest request)
Removes a data flow from a project or folder using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteDataFlow API.
DeleteDataFlowValidationResponse deleteDataFlowValidation(DeleteDataFlowValidationRequest request)
Removes a data flow validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteDataFlowValidation API.
DeleteDisApplicationResponse deleteDisApplication(DeleteDisApplicationRequest request)
Removes a DIS application using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteDisApplication API.
DeleteDisApplicationDetailedDescriptionResponse deleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteDisApplicationDetailedDescription API.
DeleteExportRequestResponse deleteExportRequest(DeleteExportRequestRequest request)
Delete export object request using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteExportRequest API.
DeleteExternalPublicationResponse deleteExternalPublication(DeleteExternalPublicationRequest request)
Removes a published object using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteExternalPublication API.
DeleteExternalPublicationValidationResponse deleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest request)
Removes a task validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteExternalPublicationValidation API.
DeleteFolderResponse deleteFolder(DeleteFolderRequest request)
Removes a folder from a project using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteFolder API.
DeleteFunctionLibraryResponse deleteFunctionLibrary(DeleteFunctionLibraryRequest request)
Removes a Function Library from a project using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteFunctionLibrary API.
DeleteImportRequestResponse deleteImportRequest(DeleteImportRequestRequest request)
Delete import object request using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteImportRequest API.
DeletePatchResponse deletePatch(DeletePatchRequest request)
Removes a patch using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeletePatch API.
DeletePipelineResponse deletePipeline(DeletePipelineRequest request)
Removes a pipeline from a project or folder using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeletePipeline API.
DeletePipelineValidationResponse deletePipelineValidation(DeletePipelineValidationRequest request)
Removes a pipeline validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeletePipelineValidation API.
DeleteProjectResponse deleteProject(DeleteProjectRequest request)
Removes a project from the workspace using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteProject API.
DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)
Endpoint to delete schedule.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteSchedule API.
DeleteTaskResponse deleteTask(DeleteTaskRequest request)
Removes a task using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteTask API.
DeleteTaskRunResponse deleteTaskRun(DeleteTaskRunRequest request)
Deletes a task run using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteTaskRun API.
DeleteTaskScheduleResponse deleteTaskSchedule(DeleteTaskScheduleRequest request)
Endpoint to delete TaskSchedule.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteTaskSchedule API.
DeleteTaskValidationResponse deleteTaskValidation(DeleteTaskValidationRequest request)
Removes a task validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteTaskValidation API.
DeleteUserDefinedFunctionResponse deleteUserDefinedFunction(DeleteUserDefinedFunctionRequest request)
Removes a UserDefinedFunction from a function library using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteUserDefinedFunction API.
DeleteUserDefinedFunctionValidationResponse deleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest request)
Removes a UserDefinedFunction validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteUserDefinedFunctionValidation API.
DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest request)
Deletes a Data Integration workspace resource using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use DeleteWorkspace API.
GetApplicationResponse getApplication(GetApplicationRequest request)
Retrieves an application using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetApplication API.
GetApplicationDetailedDescriptionResponse getApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an Application
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetApplicationDetailedDescription API.
GetCompositeStateResponse getCompositeState(GetCompositeStateRequest request)
This endpoint can be used to get composite state for a given aggregator
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetCompositeState API.
GetConnectionResponse getConnection(GetConnectionRequest request)
Retrieves the connection details using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetConnection API.
GetConnectionValidationResponse getConnectionValidation(GetConnectionValidationRequest request)
Retrieves a connection validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetConnectionValidation API.
GetCopyObjectRequestResponse getCopyObjectRequest(GetCopyObjectRequestRequest request)
This endpoint can be used to get the summary/details of object being copied.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetCopyObjectRequest API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetCountStatistic API.
GetDataAssetResponse getDataAsset(GetDataAssetRequest request)
Retrieves details of a data asset using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDataAsset API.
GetDataEntityResponse getDataEntity(GetDataEntityRequest request)
Retrieves the data entity details with the given name from live schema.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDataEntity API.
GetDataFlowResponse getDataFlow(GetDataFlowRequest request)
Retrieves a data flow using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDataFlow API.
GetDataFlowValidationResponse getDataFlowValidation(GetDataFlowValidationRequest request)
Retrieves a data flow validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDataFlowValidation API.
GetDependentObjectResponse getDependentObject(GetDependentObjectRequest request)
Retrieves the details of a dependent object from an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDependentObject API.
GetDisApplicationResponse getDisApplication(GetDisApplicationRequest request)
Retrieves an application using the specified OCID.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDisApplication API.
GetDisApplicationDetailedDescriptionResponse getDisApplicationDetailedDescription(GetDisApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetDisApplicationDetailedDescription API.
GetExportRequestResponse getExportRequest(GetExportRequestRequest request)
This endpoint can be used to get the summary/details of object being exported.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetExportRequest API.
GetExternalPublicationResponse getExternalPublication(GetExternalPublicationRequest request)
Retrieves a publshed object in an task using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetExternalPublication API.
GetExternalPublicationValidationResponse getExternalPublicationValidation(GetExternalPublicationValidationRequest request)
Retrieves an external publication validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetExternalPublicationValidation API.
GetFolderResponse getFolder(GetFolderRequest request)
Retrieves a folder using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetFolder API.
GetFunctionLibraryResponse getFunctionLibrary(GetFunctionLibraryRequest request)
Retrieves a Function Library using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetFunctionLibrary API.
GetImportRequestResponse getImportRequest(GetImportRequestRequest request)
This endpoint can be used to get the summary/details of object being imported.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetImportRequest API.
GetPatchResponse getPatch(GetPatchRequest request)
Retrieves a patch in an application using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetPatch API.
GetPipelineResponse getPipeline(GetPipelineRequest request)
Retrieves a pipeline using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetPipeline API.
GetPipelineValidationResponse getPipelineValidation(GetPipelineValidationRequest request)
Retrieves a pipeline validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetPipelineValidation API.
GetProjectResponse getProject(GetProjectRequest request)
Retrieves a project using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetProject API.
GetPublishedObjectResponse getPublishedObject(GetPublishedObjectRequest request)
Retrieves the details of a published object from an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetPublishedObject API.
GetReferenceResponse getReference(GetReferenceRequest request)
Retrieves a reference in an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetReference API.
GetRuntimeOperatorResponse getRuntimeOperator(GetRuntimeOperatorRequest request)
Retrieves a runtime operator using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetRuntimeOperator API.
GetRuntimePipelineResponse getRuntimePipeline(GetRuntimePipelineRequest request)
Retrieves a runtime pipeline using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetRuntimePipeline API.
GetScheduleResponse getSchedule(GetScheduleRequest request)
Retrieves schedule by schedule key
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetSchedule API.
GetSchemaResponse getSchema(GetSchemaRequest request)
Retrieves a schema that can be accessed using the specified connection.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetSchema API.
GetTaskResponse getTask(GetTaskRequest request)
Retrieves a task using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetTask API.
GetTaskRunResponse getTaskRun(GetTaskRunRequest request)
Retrieves a task run using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetTaskRun API.
GetTaskScheduleResponse getTaskSchedule(GetTaskScheduleRequest request)
Endpoint used to get taskSchedule by its key
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetTaskSchedule API.
GetTaskValidationResponse getTaskValidation(GetTaskValidationRequest request)
Retrieves a task validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetTaskValidation API.
GetTemplateResponse getTemplate(GetTemplateRequest request)
This endpoint can be used to get an application template using a key.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetTemplate API.
GetUserDefinedFunctionResponse getUserDefinedFunction(GetUserDefinedFunctionRequest request)
Retrieves a UserDefinedFunction using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetUserDefinedFunction API.
GetUserDefinedFunctionValidationResponse getUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest request)
Retrieves a UserDefinedFunction validation using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetUserDefinedFunctionValidation API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Retrieves the status of the work request with the given ID.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetWorkRequest API.
GetWorkspaceResponse getWorkspace(GetWorkspaceRequest request)
Retrieves a Data Integration workspace using the specified identifier.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use GetWorkspace API.
ListApplicationsResponse listApplications(ListApplicationsRequest request)
Retrieves a list of applications and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListApplications API.
ListConnectionValidationsResponse listConnectionValidations(ListConnectionValidationsRequest request)
Retrieves a list of connection validations within the specified workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListConnectionValidations API.
ListConnectionsResponse listConnections(ListConnectionsRequest request)
Retrieves a list of all connections.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListConnections API.
ListCopyObjectRequestsResponse listCopyObjectRequests(ListCopyObjectRequestsRequest request)
This endpoint can be used to get the list of copy object requests.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListCopyObjectRequests API.
ListDataAssetsResponse listDataAssets(ListDataAssetsRequest request)
Retrieves a list of all data asset summaries.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDataAssets API.
ListDataEntitiesResponse listDataEntities(ListDataEntitiesRequest request)
Lists a summary of data entities from the data asset using the specified connection.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDataEntities API.
ListDataFlowValidationsResponse listDataFlowValidations(ListDataFlowValidationsRequest request)
Retrieves a list of data flow validations within the specified workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDataFlowValidations API.
ListDataFlowsResponse listDataFlows(ListDataFlowsRequest request)
Retrieves a list of data flows in a project or folder.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDataFlows API.
ListDependentObjectsResponse listDependentObjects(ListDependentObjectsRequest request)
Retrieves a list of all dependent objects for a specific application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDependentObjects API.
ListDisApplicationTaskRunLineagesResponse listDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDisApplicationTaskRunLineages API.
ListDisApplicationsResponse listDisApplications(ListDisApplicationsRequest request)
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListDisApplications API.
ListExportRequestsResponse listExportRequests(ListExportRequestsRequest request)
This endpoint can be used to get the list of export object requests.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListExportRequests API.
ListExternalPublicationValidationsResponse listExternalPublicationValidations(ListExternalPublicationValidationsRequest request)
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListExternalPublicationValidations API.
ListExternalPublicationsResponse listExternalPublications(ListExternalPublicationsRequest request)
Retrieves a list of external publications in an application and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListExternalPublications API.
ListFoldersResponse listFolders(ListFoldersRequest request)
Retrieves a list of folders in a project and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListFolders API.
ListFunctionLibrariesResponse listFunctionLibraries(ListFunctionLibrariesRequest request)
Retrieves a list of function libraries in a project and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListFunctionLibraries API.
ListImportRequestsResponse listImportRequests(ListImportRequestsRequest request)
This endpoint can be used to get the list of import object requests.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListImportRequests API.
ListPatchChangesResponse listPatchChanges(ListPatchChangesRequest request)
Retrieves a list of patches in an application and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListPatchChanges API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListPatches API.
ListPipelineValidationsResponse listPipelineValidations(ListPipelineValidationsRequest request)
Retrieves a list of pipeline validations within the specified workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListPipelineValidations API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListPipelines API.
ListProjectsResponse listProjects(ListProjectsRequest request)
Retrieves a lists of projects in a workspace and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListProjects API.
ListPublishedObjectsResponse listPublishedObjects(ListPublishedObjectsRequest request)
Retrieves a list of all the published objects for a specified application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListPublishedObjects API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListReferences API.
ListRuntimeOperatorsResponse listRuntimeOperators(ListRuntimeOperatorsRequest request)
This endpoint can be used to list runtime operators with filtering options
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListRuntimeOperators API.
ListRuntimePipelinesResponse listRuntimePipelines(ListRuntimePipelinesRequest request)
This endpoint can be used to list runtime pipelines with filtering options
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListRuntimePipelines API.
ListSchedulesResponse listSchedules(ListSchedulesRequest request)
Use this endpoint to list schedules.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListSchedules API.
ListSchemasResponse listSchemas(ListSchemasRequest request)
Retrieves a list of all the schemas that can be accessed using the specified connection.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListSchemas API.
ListTaskRunLineagesResponse listTaskRunLineages(ListTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTaskRunLineages API.
ListTaskRunLogsResponse listTaskRunLogs(ListTaskRunLogsRequest request)
Gets log entries for task runs using its key.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTaskRunLogs API.
ListTaskRunsResponse listTaskRuns(ListTaskRunsRequest request)
Retrieves a list of task runs and provides options to filter the list.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTaskRuns API.
ListTaskSchedulesResponse listTaskSchedules(ListTaskSchedulesRequest request)
This endpoint can be used to get the list of all the TaskSchedule objects.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTaskSchedules API.
ListTaskValidationsResponse listTaskValidations(ListTaskValidationsRequest request)
Retrieves a list of task validations within the specified workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTaskValidations API.
ListTasksResponse listTasks(ListTasksRequest request)
Retrieves a list of all tasks in a specified project or folder.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTasks API.
ListTemplatesResponse listTemplates(ListTemplatesRequest request)
This endpoint can be used to list application templates with filtering options.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListTemplates API.
ListUserDefinedFunctionValidationsResponse listUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest request)
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListUserDefinedFunctionValidations API.
ListUserDefinedFunctionsResponse listUserDefinedFunctions(ListUserDefinedFunctionsRequest request)
Retrieves a list of UserDefinedFunctions in a function library.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListUserDefinedFunctions API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Retrieves a paginated list of errors for a given work request.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Retrieves a paginated list of logs for a given work request.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListWorkRequests API.
ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest request)
Retrieves a list of Data Integration workspaces.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use ListWorkspaces API.
StartWorkspaceResponse startWorkspace(StartWorkspaceRequest request)
Starts a workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use StartWorkspace API.
StopWorkspaceResponse stopWorkspace(StopWorkspaceRequest request)
Stops a workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use StopWorkspace API.
UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)
Updates an application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateApplication API.
UpdateApplicationDetailedDescriptionResponse updateApplicationDetailedDescription(UpdateApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateApplicationDetailedDescription API.
UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Updates a connection under a data asset.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateConnection API.
UpdateCopyObjectRequestResponse updateCopyObjectRequest(UpdateCopyObjectRequestRequest request)
Updates the status of a copy object request.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateCopyObjectRequest API.
UpdateDataAssetResponse updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset with default connection.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateDataAsset API.
UpdateDataFlowResponse updateDataFlow(UpdateDataFlowRequest request)
Updates a specific data flow.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateDataFlow API.
UpdateDisApplicationResponse updateDisApplication(UpdateDisApplicationRequest request)
Updates a DIS Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateDisApplication API.
UpdateDisApplicationDetailedDescriptionResponse updateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateDisApplicationDetailedDescription API.
UpdateExportRequestResponse updateExportRequest(UpdateExportRequestRequest request)
Updates the status of a export object request.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateExportRequest API.
UpdateExternalPublicationResponse updateExternalPublication(UpdateExternalPublicationRequest request)
Updates the external publication object.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateExternalPublication API.
UpdateFolderResponse updateFolder(UpdateFolderRequest request)
Updates a specific folder.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateFolder API.
UpdateFunctionLibraryResponse updateFunctionLibrary(UpdateFunctionLibraryRequest request)
Updates a specific Function Library.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateFunctionLibrary API.
UpdateImportRequestResponse updateImportRequest(UpdateImportRequestRequest request)
Updates the status of a import object request.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateImportRequest API.
UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request)
Updates a specific pipeline.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdatePipeline API.
UpdateProjectResponse updateProject(UpdateProjectRequest request)
Updates a specific project.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateProject API.
UpdateReferenceResponse updateReference(UpdateReferenceRequest request)
Updates the application references. For example, to map a data asset to a different target object.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateReference API.
UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)
Endpoint used to update the schedule
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateSchedule API.
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.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateTask API.
UpdateTaskRunResponse updateTaskRun(UpdateTaskRunRequest request)
Updates the status of the task run. For example, aborts a task run.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateTaskRun API.
UpdateTaskScheduleResponse updateTaskSchedule(UpdateTaskScheduleRequest request)
Endpoint used to update the TaskSchedule
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateTaskSchedule API.
UpdateUserDefinedFunctionResponse updateUserDefinedFunction(UpdateUserDefinedFunctionRequest request)
Updates a specific UserDefinedFunction.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateUserDefinedFunction API.
UpdateWorkspaceResponse updateWorkspace(UpdateWorkspaceRequest request)
Updates the specified Data Integration workspace.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use UpdateWorkspace API.
DataIntegrationWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2024. All rights reserved.