Class DataIntegrationClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.dataintegration.DataIntegrationClient
-
- All Implemented Interfaces:
DataIntegration
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200430") public class DataIntegrationClient extends BaseSyncClient implements DataIntegration
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataIntegrationClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for DataIntegration.
-
Constructor Summary
Constructors Constructor Description DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DataIntegrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DataIntegrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DataIntegrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataIntegrationClient.Builder
builder()
Create a builder for this client.ChangeCompartmentResponse
changeCompartment(ChangeCompartmentRequest request)
Moves a workspace to a specified compartment.ChangeDisApplicationCompartmentResponse
changeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest request)
Moves a DIS Application to a specified compartment.void
close()
CreateApplicationResponse
createApplication(CreateApplicationRequest request)
Creates an application.CreateApplicationDetailedDescriptionResponse
createApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.CreateConnectionResponse
createConnection(CreateConnectionRequest request)
Creates a connection under an existing data asset.CreateConnectionValidationResponse
createConnectionValidation(CreateConnectionValidationRequest request)
Creates a connection validation.CreateCopyObjectRequestResponse
createCopyObjectRequest(CreateCopyObjectRequestRequest request)
Copy Metadata Object.CreateDataAssetResponse
createDataAsset(CreateDataAssetRequest request)
Creates a data asset with default connection.CreateDataFlowResponse
createDataFlow(CreateDataFlowRequest request)
Creates a new data flow in a project or folder ready for performing data integrations.CreateDataFlowValidationResponse
createDataFlowValidation(CreateDataFlowValidationRequest request)
Accepts the data flow definition in the request payload and creates a data flow validation.CreateDisApplicationResponse
createDisApplication(CreateDisApplicationRequest request)
Creates a DIS Application.CreateDisApplicationDetailedDescriptionResponse
createDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest request)
Creates detailed description for an application.CreateEntityShapeResponse
createEntityShape(CreateEntityShapeRequest request)
Creates the data entity shape using the shape from the data asset.CreateExportRequestResponse
createExportRequest(CreateExportRequestRequest request)
Export Metadata ObjectCreateExternalPublicationResponse
createExternalPublication(CreateExternalPublicationRequest request)
Publish a DataFlow in a OCI DataFlow application.CreateExternalPublicationValidationResponse
createExternalPublicationValidation(CreateExternalPublicationValidationRequest request)
Validates a specific task.CreateFolderResponse
createFolder(CreateFolderRequest request)
Creates a folder in a project or in another folder, limited to two levels of folders.CreateFunctionLibraryResponse
createFunctionLibrary(CreateFunctionLibraryRequest request)
Creates a function library in a project or in another function library, limited to two levels of function libraries.CreateImportRequestResponse
createImportRequest(CreateImportRequestRequest request)
Import Metadata ObjectCreatePatchResponse
createPatch(CreatePatchRequest request)
Creates a patch in an application.CreatePipelineResponse
createPipeline(CreatePipelineRequest request)
Creates a new pipeline in a project or folder ready for performing task orchestration.CreatePipelineValidationResponse
createPipelineValidation(CreatePipelineValidationRequest request)
Accepts the data flow definition in the request payload and creates a pipeline validation.CreateProjectResponse
createProject(CreateProjectRequest request)
Creates a project.CreateScheduleResponse
createSchedule(CreateScheduleRequest request)
Endpoint to create a new scheduleCreateTaskResponse
createTask(CreateTaskRequest request)
Creates a new task ready for performing data integrations.CreateTaskRunResponse
createTaskRun(CreateTaskRunRequest request)
Creates a data integration task run for the specified task.CreateTaskScheduleResponse
createTaskSchedule(CreateTaskScheduleRequest request)
Endpoint to be used create TaskSchedule.CreateTaskValidationResponse
createTaskValidation(CreateTaskValidationRequest request)
Validates a specific task.CreateUserDefinedFunctionResponse
createUserDefinedFunction(CreateUserDefinedFunctionRequest request)
Creates a new UserDefinedFunction in a function library ready for performing data integrations.CreateUserDefinedFunctionValidationResponse
createUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest request)
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.CreateWorkspaceResponse
createWorkspace(CreateWorkspaceRequest request)
Creates a new Data Integration workspace ready for performing data integration tasks.DeleteApplicationResponse
deleteApplication(DeleteApplicationRequest request)
Removes an application using the specified identifier.DeleteApplicationDetailedDescriptionResponse
deleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.DeleteConnectionResponse
deleteConnection(DeleteConnectionRequest request)
Removes a connection using the specified identifier.DeleteConnectionValidationResponse
deleteConnectionValidation(DeleteConnectionValidationRequest request)
Deletes a connection validation.DeleteCopyObjectRequestResponse
deleteCopyObjectRequest(DeleteCopyObjectRequestRequest request)
Delete copy object request using the specified identifier.DeleteDataAssetResponse
deleteDataAsset(DeleteDataAssetRequest request)
Removes a data asset using the specified identifier.DeleteDataFlowResponse
deleteDataFlow(DeleteDataFlowRequest request)
Removes a data flow from a project or folder using the specified identifier.DeleteDataFlowValidationResponse
deleteDataFlowValidation(DeleteDataFlowValidationRequest request)
Removes a data flow validation using the specified identifier.DeleteDisApplicationResponse
deleteDisApplication(DeleteDisApplicationRequest request)
Removes a DIS application using the specified identifier.DeleteDisApplicationDetailedDescriptionResponse
deleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest request)
Deletes detailed description of an Application.DeleteExportRequestResponse
deleteExportRequest(DeleteExportRequestRequest request)
Delete export object request using the specified identifier.DeleteExternalPublicationResponse
deleteExternalPublication(DeleteExternalPublicationRequest request)
Removes a published object using the specified identifier.DeleteExternalPublicationValidationResponse
deleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest request)
Removes a task validation using the specified identifier.DeleteFolderResponse
deleteFolder(DeleteFolderRequest request)
Removes a folder from a project using the specified identifier.DeleteFunctionLibraryResponse
deleteFunctionLibrary(DeleteFunctionLibraryRequest request)
Removes a Function Library from a project using the specified identifier.DeleteImportRequestResponse
deleteImportRequest(DeleteImportRequestRequest request)
Delete import object request using the specified identifier.DeletePatchResponse
deletePatch(DeletePatchRequest request)
Removes a patch using the specified identifier.DeletePipelineResponse
deletePipeline(DeletePipelineRequest request)
Removes a pipeline from a project or folder using the specified identifier.DeletePipelineValidationResponse
deletePipelineValidation(DeletePipelineValidationRequest request)
Removes a pipeline validation using the specified identifier.DeleteProjectResponse
deleteProject(DeleteProjectRequest request)
Removes a project from the workspace using the specified identifier.DeleteScheduleResponse
deleteSchedule(DeleteScheduleRequest request)
Endpoint to delete schedule.DeleteTaskResponse
deleteTask(DeleteTaskRequest request)
Removes a task using the specified identifier.DeleteTaskRunResponse
deleteTaskRun(DeleteTaskRunRequest request)
Deletes a task run using the specified identifier.DeleteTaskScheduleResponse
deleteTaskSchedule(DeleteTaskScheduleRequest request)
Endpoint to delete TaskSchedule.DeleteTaskValidationResponse
deleteTaskValidation(DeleteTaskValidationRequest request)
Removes a task validation using the specified identifier.DeleteUserDefinedFunctionResponse
deleteUserDefinedFunction(DeleteUserDefinedFunctionRequest request)
Removes a UserDefinedFunction from a function library using the specified identifier.DeleteUserDefinedFunctionValidationResponse
deleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest request)
Removes a UserDefinedFunction validation using the specified identifier.DeleteWorkspaceResponse
deleteWorkspace(DeleteWorkspaceRequest request)
Deletes a Data Integration workspace resource using the specified identifier.GetApplicationResponse
getApplication(GetApplicationRequest request)
Retrieves an application using the specified identifier.GetApplicationDetailedDescriptionResponse
getApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest request)
Retrieves detailed description of an ApplicationString
getClientCommonLibraryVersion()
GetCompositeStateResponse
getCompositeState(GetCompositeStateRequest request)
This endpoint can be used to get composite state for a given aggregatorGetConnectionResponse
getConnection(GetConnectionRequest request)
Retrieves the connection details using the specified identifier.GetConnectionValidationResponse
getConnectionValidation(GetConnectionValidationRequest request)
Retrieves a connection validation using the specified identifier.GetCopyObjectRequestResponse
getCopyObjectRequest(GetCopyObjectRequestRequest request)
This endpoint can be used to get the summary/details of object being copied.GetCountStatisticResponse
getCountStatistic(GetCountStatisticRequest request)
Retrieves statistics on a workspace.GetDataAssetResponse
getDataAsset(GetDataAssetRequest request)
Retrieves details of a data asset using the specified identifier.GetDataEntityResponse
getDataEntity(GetDataEntityRequest request)
Retrieves the data entity details with the given name from live schema.GetDataFlowResponse
getDataFlow(GetDataFlowRequest request)
Retrieves a data flow using the specified identifier.GetDataFlowValidationResponse
getDataFlowValidation(GetDataFlowValidationRequest request)
Retrieves a data flow validation using the specified identifier.protected ClientConfigurator
getDefaultConfigurator()
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()
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.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
DataIntegrationPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPatchResponse
getPatch(GetPatchRequest request)
Retrieves a patch in an application using the specified identifier.GetPipelineResponse
getPipeline(GetPipelineRequest request)
Retrieves a pipeline using the specified identifier.GetPipelineValidationResponse
getPipelineValidation(GetPipelineValidationRequest request)
Retrieves a pipeline validation using the specified identifier.GetProjectResponse
getProject(GetProjectRequest request)
Retrieves a project using the specified identifier.GetPublishedObjectResponse
getPublishedObject(GetPublishedObjectRequest request)
Retrieves the details of a published object from an application.GetReferenceResponse
getReference(GetReferenceRequest request)
Retrieves a reference in an application.GetRuntimeOperatorResponse
getRuntimeOperator(GetRuntimeOperatorRequest request)
Retrieves a runtime operator using the specified identifier.GetRuntimePipelineResponse
getRuntimePipeline(GetRuntimePipelineRequest request)
Retrieves a runtime pipeline using the specified identifier.GetScheduleResponse
getSchedule(GetScheduleRequest request)
Retrieves schedule by schedule keyGetSchemaResponse
getSchema(GetSchemaRequest request)
Retrieves a schema that can be accessed using the specified connection.GetTaskResponse
getTask(GetTaskRequest request)
Retrieves a task using the specified identifier.GetTaskRunResponse
getTaskRun(GetTaskRunRequest request)
Retrieves a task run using the specified identifier.GetTaskScheduleResponse
getTaskSchedule(GetTaskScheduleRequest request)
Endpoint used to get taskSchedule by its keyGetTaskValidationResponse
getTaskValidation(GetTaskValidationRequest request)
Retrieves a task validation using the specified identifier.GetTemplateResponse
getTemplate(GetTemplateRequest request)
This endpoint can be used to get an application template using a key.GetUserDefinedFunctionResponse
getUserDefinedFunction(GetUserDefinedFunctionRequest request)
Retrieves a UserDefinedFunction using the specified identifier.GetUserDefinedFunctionValidationResponse
getUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest request)
Retrieves a UserDefinedFunction validation using the specified identifier.DataIntegrationWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Retrieves the status of the work request with the given ID.GetWorkspaceResponse
getWorkspace(GetWorkspaceRequest request)
Retrieves a Data Integration workspace using the specified identifier.ListApplicationsResponse
listApplications(ListApplicationsRequest request)
Retrieves a list of applications and provides options to filter the list.ListConnectionsResponse
listConnections(ListConnectionsRequest request)
Retrieves a list of all connections.ListConnectionValidationsResponse
listConnectionValidations(ListConnectionValidationsRequest request)
Retrieves a list of connection validations within the specified workspace.ListCopyObjectRequestsResponse
listCopyObjectRequests(ListCopyObjectRequestsRequest request)
This endpoint can be used to get the list of copy object requests.ListDataAssetsResponse
listDataAssets(ListDataAssetsRequest request)
Retrieves a list of all data asset summaries.ListDataEntitiesResponse
listDataEntities(ListDataEntitiesRequest request)
Lists a summary of data entities from the data asset using the specified connection.ListDataFlowsResponse
listDataFlows(ListDataFlowsRequest request)
Retrieves a list of data flows in a project or folder.ListDataFlowValidationsResponse
listDataFlowValidations(ListDataFlowValidationsRequest request)
Retrieves a list of data flow validations within the specified workspace.ListDependentObjectsResponse
listDependentObjects(ListDependentObjectsRequest request)
Retrieves a list of all dependent objects for a specific application.ListDisApplicationsResponse
listDisApplications(ListDisApplicationsRequest request)
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.ListDisApplicationTaskRunLineagesResponse
listDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.ListExportRequestsResponse
listExportRequests(ListExportRequestsRequest request)
This endpoint can be used to get the list of export object requests.ListExternalPublicationsResponse
listExternalPublications(ListExternalPublicationsRequest request)
Retrieves a list of external publications in an application and provides options to filter the list.ListExternalPublicationValidationsResponse
listExternalPublicationValidations(ListExternalPublicationValidationsRequest request)
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.ListFoldersResponse
listFolders(ListFoldersRequest request)
Retrieves a list of folders in a project and provides options to filter the list.ListFunctionLibrariesResponse
listFunctionLibraries(ListFunctionLibrariesRequest request)
Retrieves a list of function libraries in a project and provides options to filter the list.ListImportRequestsResponse
listImportRequests(ListImportRequestsRequest request)
This endpoint can be used to get the list of import object requests.ListPatchChangesResponse
listPatchChanges(ListPatchChangesRequest request)
Retrieves a list of patches in an application and provides options to filter the list.ListPatchesResponse
listPatches(ListPatchesRequest request)
Retrieves a list of patches in an application and provides options to filter the list.ListPipelinesResponse
listPipelines(ListPipelinesRequest request)
Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.ListPipelineValidationsResponse
listPipelineValidations(ListPipelineValidationsRequest request)
Retrieves a list of pipeline validations within the specified workspace.ListProjectsResponse
listProjects(ListProjectsRequest request)
Retrieves a lists of projects in a workspace and provides options to filter the list.ListPublishedObjectsResponse
listPublishedObjects(ListPublishedObjectsRequest request)
Retrieves a list of all the published objects for a specified application.ListReferencesResponse
listReferences(ListReferencesRequest request)
Retrieves a list of references in an application.ListRuntimeOperatorsResponse
listRuntimeOperators(ListRuntimeOperatorsRequest request)
This endpoint can be used to list runtime operators with filtering optionsListRuntimePipelinesResponse
listRuntimePipelines(ListRuntimePipelinesRequest request)
This endpoint can be used to list runtime pipelines with filtering optionsListSchedulesResponse
listSchedules(ListSchedulesRequest request)
Use this endpoint to list schedules.ListSchemasResponse
listSchemas(ListSchemasRequest request)
Retrieves a list of all the schemas that can be accessed using the specified connection.ListTaskRunLineagesResponse
listTaskRunLineages(ListTaskRunLineagesRequest request)
This endpoint can be used to list Task Run Lineages within a given time window.ListTaskRunLogsResponse
listTaskRunLogs(ListTaskRunLogsRequest request)
Gets log entries for task runs using its key.ListTaskRunsResponse
listTaskRuns(ListTaskRunsRequest request)
Retrieves a list of task runs and provides options to filter the list.ListTasksResponse
listTasks(ListTasksRequest request)
Retrieves a list of all tasks in a specified project or folder.ListTaskSchedulesResponse
listTaskSchedules(ListTaskSchedulesRequest request)
This endpoint can be used to get the list of all the TaskSchedule objects.ListTaskValidationsResponse
listTaskValidations(ListTaskValidationsRequest request)
Retrieves a list of task validations within the specified workspace.ListTemplatesResponse
listTemplates(ListTemplatesRequest request)
This endpoint can be used to list application templates with filtering options.ListUserDefinedFunctionsResponse
listUserDefinedFunctions(ListUserDefinedFunctionsRequest request)
Retrieves a list of UserDefinedFunctions in a function library.ListUserDefinedFunctionValidationsResponse
listUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest request)
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Retrieves a paginated list of errors for a given work request.ListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Retrieves a paginated list of logs for a given work request.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.ListWorkspacesResponse
listWorkspaces(ListWorkspacesRequest request)
Retrieves a list of Data Integration workspaces.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.void
setEndpoint(String endpoint)
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.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateConnectionResponse
updateConnection(UpdateConnectionRequest request)
Updates a connection under a data asset.UpdateCopyObjectRequestResponse
updateCopyObjectRequest(UpdateCopyObjectRequestRequest request)
Updates the status of a copy object request.UpdateDataAssetResponse
updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset with default connection.UpdateDataFlowResponse
updateDataFlow(UpdateDataFlowRequest request)
Updates a specific data flow.UpdateDisApplicationResponse
updateDisApplication(UpdateDisApplicationRequest request)
Updates a DIS Application.UpdateDisApplicationDetailedDescriptionResponse
updateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest request)
Updates the detailed description of an Application.UpdateExportRequestResponse
updateExportRequest(UpdateExportRequestRequest request)
Updates the status of a export object request.UpdateExternalPublicationResponse
updateExternalPublication(UpdateExternalPublicationRequest request)
Updates the external publication object.UpdateFolderResponse
updateFolder(UpdateFolderRequest request)
Updates a specific folder.UpdateFunctionLibraryResponse
updateFunctionLibrary(UpdateFunctionLibraryRequest request)
Updates a specific Function Library.UpdateImportRequestResponse
updateImportRequest(UpdateImportRequestRequest request)
Updates the status of a import object request.UpdatePipelineResponse
updatePipeline(UpdatePipelineRequest request)
Updates a specific pipeline.UpdateProjectResponse
updateProject(UpdateProjectRequest request)
Updates a specific project.UpdateReferenceResponse
updateReference(UpdateReferenceRequest request)
Updates the application references.UpdateScheduleResponse
updateSchedule(UpdateScheduleRequest request)
Endpoint used to update the scheduleUpdateTaskResponse
updateTask(UpdateTaskRequest request)
Updates a specific task.UpdateTaskRunResponse
updateTaskRun(UpdateTaskRunRequest request)
Updates the status of the task run.UpdateTaskScheduleResponse
updateTaskSchedule(UpdateTaskScheduleRequest request)
Endpoint used to update the TaskScheduleUpdateUserDefinedFunctionResponse
updateUserDefinedFunction(UpdateUserDefinedFunctionRequest request)
Updates a specific UserDefinedFunction.UpdateWorkspaceResponse
updateWorkspace(UpdateWorkspaceRequest request)
Updates the specified Data Integration workspace.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.dataintegration.DataIntegration
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
DataIntegrationClient
@Deprecated public DataIntegrationClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataIntegrationClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-DataIntegrationClient.Builder.executorService
-
-
Method Detail
-
builder
public static DataIntegrationClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DataIntegration
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.- Specified by:
setRegion
in interfaceDataIntegration
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DataIntegration
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Specified by:
setRegion
in interfaceDataIntegration
- Parameters:
regionId
- The public region ID.
-
changeCompartment
public ChangeCompartmentResponse changeCompartment(ChangeCompartmentRequest request)
Description copied from interface:DataIntegration
Moves a workspace to a specified compartment.- Specified by:
changeCompartment
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDisApplicationCompartment
public ChangeDisApplicationCompartmentResponse changeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest request)
Description copied from interface:DataIntegration
Moves a DIS Application to a specified compartment.- Specified by:
changeDisApplicationCompartment
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createApplication
public CreateApplicationResponse createApplication(CreateApplicationRequest request)
Description copied from interface:DataIntegration
Creates an application.- Specified by:
createApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createApplicationDetailedDescription
public CreateApplicationDetailedDescriptionResponse createApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Creates detailed description for an application.- Specified by:
createApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createConnection
public CreateConnectionResponse createConnection(CreateConnectionRequest request)
Description copied from interface:DataIntegration
Creates a connection under an existing data asset.- Specified by:
createConnection
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createConnectionValidation
public CreateConnectionValidationResponse createConnectionValidation(CreateConnectionValidationRequest request)
Description copied from interface:DataIntegration
Creates a connection validation.- Specified by:
createConnectionValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCopyObjectRequest
public CreateCopyObjectRequestResponse createCopyObjectRequest(CreateCopyObjectRequestRequest request)
Description copied from interface:DataIntegration
Copy Metadata Object.- Specified by:
createCopyObjectRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataAsset
public CreateDataAssetResponse createDataAsset(CreateDataAssetRequest request)
Description copied from interface:DataIntegration
Creates a data asset with default connection.- Specified by:
createDataAsset
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataFlow
public CreateDataFlowResponse createDataFlow(CreateDataFlowRequest request)
Description copied from interface:DataIntegration
Creates a new data flow in a project or folder ready for performing data integrations.- Specified by:
createDataFlow
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataFlowValidation
public CreateDataFlowValidationResponse createDataFlowValidation(CreateDataFlowValidationRequest request)
Description copied from interface:DataIntegration
Accepts the data flow definition in the request payload and creates a data flow validation.- Specified by:
createDataFlowValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDisApplication
public CreateDisApplicationResponse createDisApplication(CreateDisApplicationRequest request)
Description copied from interface:DataIntegration
Creates a DIS Application.- Specified by:
createDisApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDisApplicationDetailedDescription
public CreateDisApplicationDetailedDescriptionResponse createDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Creates detailed description for an application.- Specified by:
createDisApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createEntityShape
public CreateEntityShapeResponse createEntityShape(CreateEntityShapeRequest request)
Description copied from interface:DataIntegration
Creates the data entity shape using the shape from the data asset.- Specified by:
createEntityShape
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createExportRequest
public CreateExportRequestResponse createExportRequest(CreateExportRequestRequest request)
Description copied from interface:DataIntegration
Export Metadata Object- Specified by:
createExportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createExternalPublication
public CreateExternalPublicationResponse createExternalPublication(CreateExternalPublicationRequest request)
Description copied from interface:DataIntegration
Publish a DataFlow in a OCI DataFlow application.- Specified by:
createExternalPublication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createExternalPublicationValidation
public CreateExternalPublicationValidationResponse createExternalPublicationValidation(CreateExternalPublicationValidationRequest request)
Description copied from interface:DataIntegration
Validates a specific task.- Specified by:
createExternalPublicationValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createFolder
public CreateFolderResponse createFolder(CreateFolderRequest request)
Description copied from interface:DataIntegration
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.
- Specified by:
createFolder
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createFunctionLibrary
public CreateFunctionLibraryResponse createFunctionLibrary(CreateFunctionLibraryRequest request)
Description copied from interface:DataIntegration
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.
- Specified by:
createFunctionLibrary
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createImportRequest
public CreateImportRequestResponse createImportRequest(CreateImportRequestRequest request)
Description copied from interface:DataIntegration
Import Metadata Object- Specified by:
createImportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPatch
public CreatePatchResponse createPatch(CreatePatchRequest request)
Description copied from interface:DataIntegration
Creates a patch in an application.- Specified by:
createPatch
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPipeline
public CreatePipelineResponse createPipeline(CreatePipelineRequest request)
Description copied from interface:DataIntegration
Creates a new pipeline in a project or folder ready for performing task orchestration.- Specified by:
createPipeline
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPipelineValidation
public CreatePipelineValidationResponse createPipelineValidation(CreatePipelineValidationRequest request)
Description copied from interface:DataIntegration
Accepts the data flow definition in the request payload and creates a pipeline validation.- Specified by:
createPipelineValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createProject
public CreateProjectResponse createProject(CreateProjectRequest request)
Description copied from interface:DataIntegration
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.
- Specified by:
createProject
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSchedule
public CreateScheduleResponse createSchedule(CreateScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint to create a new schedule- Specified by:
createSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTask
public CreateTaskResponse createTask(CreateTaskRequest request)
Description copied from interface:DataIntegration
Creates a new task ready for performing data integrations.There are specialized types of tasks that include data loader and integration tasks.
- Specified by:
createTask
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTaskRun
public CreateTaskRunResponse createTaskRun(CreateTaskRunRequest request)
Description copied from interface:DataIntegration
Creates a data integration task run for the specified task.- Specified by:
createTaskRun
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTaskSchedule
public CreateTaskScheduleResponse createTaskSchedule(CreateTaskScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint to be used create TaskSchedule.- Specified by:
createTaskSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTaskValidation
public CreateTaskValidationResponse createTaskValidation(CreateTaskValidationRequest request)
Description copied from interface:DataIntegration
Validates a specific task.- Specified by:
createTaskValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createUserDefinedFunction
public CreateUserDefinedFunctionResponse createUserDefinedFunction(CreateUserDefinedFunctionRequest request)
Description copied from interface:DataIntegration
Creates a new UserDefinedFunction in a function library ready for performing data integrations.- Specified by:
createUserDefinedFunction
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createUserDefinedFunctionValidation
public CreateUserDefinedFunctionValidationResponse createUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest request)
Description copied from interface:DataIntegration
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.- Specified by:
createUserDefinedFunctionValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createWorkspace
public CreateWorkspaceResponse createWorkspace(CreateWorkspaceRequest request)
Description copied from interface:DataIntegration
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.- Specified by:
createWorkspace
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteApplication
public DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)
Description copied from interface:DataIntegration
Removes an application using the specified identifier.- Specified by:
deleteApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteApplicationDetailedDescription
public DeleteApplicationDetailedDescriptionResponse deleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Deletes detailed description of an Application.- Specified by:
deleteApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConnection
public DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Description copied from interface:DataIntegration
Removes a connection using the specified identifier.- Specified by:
deleteConnection
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConnectionValidation
public DeleteConnectionValidationResponse deleteConnectionValidation(DeleteConnectionValidationRequest request)
Description copied from interface:DataIntegration
Deletes a connection validation.- Specified by:
deleteConnectionValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCopyObjectRequest
public DeleteCopyObjectRequestResponse deleteCopyObjectRequest(DeleteCopyObjectRequestRequest request)
Description copied from interface:DataIntegration
Delete copy object request using the specified identifier.- Specified by:
deleteCopyObjectRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataAsset
public DeleteDataAssetResponse deleteDataAsset(DeleteDataAssetRequest request)
Description copied from interface:DataIntegration
Removes a data asset using the specified identifier.- Specified by:
deleteDataAsset
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataFlow
public DeleteDataFlowResponse deleteDataFlow(DeleteDataFlowRequest request)
Description copied from interface:DataIntegration
Removes a data flow from a project or folder using the specified identifier.- Specified by:
deleteDataFlow
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataFlowValidation
public DeleteDataFlowValidationResponse deleteDataFlowValidation(DeleteDataFlowValidationRequest request)
Description copied from interface:DataIntegration
Removes a data flow validation using the specified identifier.- Specified by:
deleteDataFlowValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDisApplication
public DeleteDisApplicationResponse deleteDisApplication(DeleteDisApplicationRequest request)
Description copied from interface:DataIntegration
Removes a DIS application using the specified identifier.- Specified by:
deleteDisApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDisApplicationDetailedDescription
public DeleteDisApplicationDetailedDescriptionResponse deleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Deletes detailed description of an Application.- Specified by:
deleteDisApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteExportRequest
public DeleteExportRequestResponse deleteExportRequest(DeleteExportRequestRequest request)
Description copied from interface:DataIntegration
Delete export object request using the specified identifier.- Specified by:
deleteExportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteExternalPublication
public DeleteExternalPublicationResponse deleteExternalPublication(DeleteExternalPublicationRequest request)
Description copied from interface:DataIntegration
Removes a published object using the specified identifier.- Specified by:
deleteExternalPublication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteExternalPublicationValidation
public DeleteExternalPublicationValidationResponse deleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest request)
Description copied from interface:DataIntegration
Removes a task validation using the specified identifier.- Specified by:
deleteExternalPublicationValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteFolder
public DeleteFolderResponse deleteFolder(DeleteFolderRequest request)
Description copied from interface:DataIntegration
Removes a folder from a project using the specified identifier.- Specified by:
deleteFolder
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteFunctionLibrary
public DeleteFunctionLibraryResponse deleteFunctionLibrary(DeleteFunctionLibraryRequest request)
Description copied from interface:DataIntegration
Removes a Function Library from a project using the specified identifier.- Specified by:
deleteFunctionLibrary
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteImportRequest
public DeleteImportRequestResponse deleteImportRequest(DeleteImportRequestRequest request)
Description copied from interface:DataIntegration
Delete import object request using the specified identifier.- Specified by:
deleteImportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePatch
public DeletePatchResponse deletePatch(DeletePatchRequest request)
Description copied from interface:DataIntegration
Removes a patch using the specified identifier.- Specified by:
deletePatch
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePipeline
public DeletePipelineResponse deletePipeline(DeletePipelineRequest request)
Description copied from interface:DataIntegration
Removes a pipeline from a project or folder using the specified identifier.- Specified by:
deletePipeline
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePipelineValidation
public DeletePipelineValidationResponse deletePipelineValidation(DeletePipelineValidationRequest request)
Description copied from interface:DataIntegration
Removes a pipeline validation using the specified identifier.- Specified by:
deletePipelineValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteProject
public DeleteProjectResponse deleteProject(DeleteProjectRequest request)
Description copied from interface:DataIntegration
Removes a project from the workspace using the specified identifier.- Specified by:
deleteProject
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSchedule
public DeleteScheduleResponse deleteSchedule(DeleteScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint to delete schedule.- Specified by:
deleteSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTask
public DeleteTaskResponse deleteTask(DeleteTaskRequest request)
Description copied from interface:DataIntegration
Removes a task using the specified identifier.- Specified by:
deleteTask
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTaskRun
public DeleteTaskRunResponse deleteTaskRun(DeleteTaskRunRequest request)
Description copied from interface:DataIntegration
Deletes a task run using the specified identifier.- Specified by:
deleteTaskRun
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTaskSchedule
public DeleteTaskScheduleResponse deleteTaskSchedule(DeleteTaskScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint to delete TaskSchedule.- Specified by:
deleteTaskSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTaskValidation
public DeleteTaskValidationResponse deleteTaskValidation(DeleteTaskValidationRequest request)
Description copied from interface:DataIntegration
Removes a task validation using the specified identifier.- Specified by:
deleteTaskValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteUserDefinedFunction
public DeleteUserDefinedFunctionResponse deleteUserDefinedFunction(DeleteUserDefinedFunctionRequest request)
Description copied from interface:DataIntegration
Removes a UserDefinedFunction from a function library using the specified identifier.- Specified by:
deleteUserDefinedFunction
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteUserDefinedFunctionValidation
public DeleteUserDefinedFunctionValidationResponse deleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest request)
Description copied from interface:DataIntegration
Removes a UserDefinedFunction validation using the specified identifier.- Specified by:
deleteUserDefinedFunctionValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteWorkspace
public DeleteWorkspaceResponse deleteWorkspace(DeleteWorkspaceRequest request)
Description copied from interface:DataIntegration
Deletes a Data Integration workspace resource using the specified identifier.- Specified by:
deleteWorkspace
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApplication
public GetApplicationResponse getApplication(GetApplicationRequest request)
Description copied from interface:DataIntegration
Retrieves an application using the specified identifier.- Specified by:
getApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getApplicationDetailedDescription
public GetApplicationDetailedDescriptionResponse getApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Retrieves detailed description of an Application- Specified by:
getApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCompositeState
public GetCompositeStateResponse getCompositeState(GetCompositeStateRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get composite state for a given aggregator- Specified by:
getCompositeState
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConnection
public GetConnectionResponse getConnection(GetConnectionRequest request)
Description copied from interface:DataIntegration
Retrieves the connection details using the specified identifier.- Specified by:
getConnection
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConnectionValidation
public GetConnectionValidationResponse getConnectionValidation(GetConnectionValidationRequest request)
Description copied from interface:DataIntegration
Retrieves a connection validation using the specified identifier.- Specified by:
getConnectionValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCopyObjectRequest
public GetCopyObjectRequestResponse getCopyObjectRequest(GetCopyObjectRequestRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the summary/details of object being copied.- Specified by:
getCopyObjectRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCountStatistic
public GetCountStatisticResponse getCountStatistic(GetCountStatisticRequest request)
Description copied from interface:DataIntegration
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.
- Specified by:
getCountStatistic
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataAsset
public GetDataAssetResponse getDataAsset(GetDataAssetRequest request)
Description copied from interface:DataIntegration
Retrieves details of a data asset using the specified identifier.- Specified by:
getDataAsset
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataEntity
public GetDataEntityResponse getDataEntity(GetDataEntityRequest request)
Description copied from interface:DataIntegration
Retrieves the data entity details with the given name from live schema.- Specified by:
getDataEntity
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataFlow
public GetDataFlowResponse getDataFlow(GetDataFlowRequest request)
Description copied from interface:DataIntegration
Retrieves a data flow using the specified identifier.- Specified by:
getDataFlow
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataFlowValidation
public GetDataFlowValidationResponse getDataFlowValidation(GetDataFlowValidationRequest request)
Description copied from interface:DataIntegration
Retrieves a data flow validation using the specified identifier.- Specified by:
getDataFlowValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDependentObject
public GetDependentObjectResponse getDependentObject(GetDependentObjectRequest request)
Description copied from interface:DataIntegration
Retrieves the details of a dependent object from an application.- Specified by:
getDependentObject
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDisApplication
public GetDisApplicationResponse getDisApplication(GetDisApplicationRequest request)
Description copied from interface:DataIntegration
Retrieves an application using the specified OCID.- Specified by:
getDisApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDisApplicationDetailedDescription
public GetDisApplicationDetailedDescriptionResponse getDisApplicationDetailedDescription(GetDisApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Retrieves detailed description of an Application.- Specified by:
getDisApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getExportRequest
public GetExportRequestResponse getExportRequest(GetExportRequestRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the summary/details of object being exported.- Specified by:
getExportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getExternalPublication
public GetExternalPublicationResponse getExternalPublication(GetExternalPublicationRequest request)
Description copied from interface:DataIntegration
Retrieves a publshed object in an task using the specified identifier.- Specified by:
getExternalPublication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getExternalPublicationValidation
public GetExternalPublicationValidationResponse getExternalPublicationValidation(GetExternalPublicationValidationRequest request)
Description copied from interface:DataIntegration
Retrieves an external publication validation using the specified identifier.- Specified by:
getExternalPublicationValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFolder
public GetFolderResponse getFolder(GetFolderRequest request)
Description copied from interface:DataIntegration
Retrieves a folder using the specified identifier.- Specified by:
getFolder
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFunctionLibrary
public GetFunctionLibraryResponse getFunctionLibrary(GetFunctionLibraryRequest request)
Description copied from interface:DataIntegration
Retrieves a Function Library using the specified identifier.- Specified by:
getFunctionLibrary
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getImportRequest
public GetImportRequestResponse getImportRequest(GetImportRequestRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the summary/details of object being imported.- Specified by:
getImportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPatch
public GetPatchResponse getPatch(GetPatchRequest request)
Description copied from interface:DataIntegration
Retrieves a patch in an application using the specified identifier.- Specified by:
getPatch
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPipeline
public GetPipelineResponse getPipeline(GetPipelineRequest request)
Description copied from interface:DataIntegration
Retrieves a pipeline using the specified identifier.- Specified by:
getPipeline
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPipelineValidation
public GetPipelineValidationResponse getPipelineValidation(GetPipelineValidationRequest request)
Description copied from interface:DataIntegration
Retrieves a pipeline validation using the specified identifier.- Specified by:
getPipelineValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getProject
public GetProjectResponse getProject(GetProjectRequest request)
Description copied from interface:DataIntegration
Retrieves a project using the specified identifier.- Specified by:
getProject
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPublishedObject
public GetPublishedObjectResponse getPublishedObject(GetPublishedObjectRequest request)
Description copied from interface:DataIntegration
Retrieves the details of a published object from an application.- Specified by:
getPublishedObject
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getReference
public GetReferenceResponse getReference(GetReferenceRequest request)
Description copied from interface:DataIntegration
Retrieves a reference in an application.- Specified by:
getReference
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRuntimeOperator
public GetRuntimeOperatorResponse getRuntimeOperator(GetRuntimeOperatorRequest request)
Description copied from interface:DataIntegration
Retrieves a runtime operator using the specified identifier.- Specified by:
getRuntimeOperator
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getRuntimePipeline
public GetRuntimePipelineResponse getRuntimePipeline(GetRuntimePipelineRequest request)
Description copied from interface:DataIntegration
Retrieves a runtime pipeline using the specified identifier.- Specified by:
getRuntimePipeline
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSchedule
public GetScheduleResponse getSchedule(GetScheduleRequest request)
Description copied from interface:DataIntegration
Retrieves schedule by schedule key- Specified by:
getSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSchema
public GetSchemaResponse getSchema(GetSchemaRequest request)
Description copied from interface:DataIntegration
Retrieves a schema that can be accessed using the specified connection.- Specified by:
getSchema
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTask
public GetTaskResponse getTask(GetTaskRequest request)
Description copied from interface:DataIntegration
Retrieves a task using the specified identifier.- Specified by:
getTask
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTaskRun
public GetTaskRunResponse getTaskRun(GetTaskRunRequest request)
Description copied from interface:DataIntegration
Retrieves a task run using the specified identifier.- Specified by:
getTaskRun
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTaskSchedule
public GetTaskScheduleResponse getTaskSchedule(GetTaskScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint used to get taskSchedule by its key- Specified by:
getTaskSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTaskValidation
public GetTaskValidationResponse getTaskValidation(GetTaskValidationRequest request)
Description copied from interface:DataIntegration
Retrieves a task validation using the specified identifier.- Specified by:
getTaskValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTemplate
public GetTemplateResponse getTemplate(GetTemplateRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get an application template using a key.- Specified by:
getTemplate
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUserDefinedFunction
public GetUserDefinedFunctionResponse getUserDefinedFunction(GetUserDefinedFunctionRequest request)
Description copied from interface:DataIntegration
Retrieves a UserDefinedFunction using the specified identifier.- Specified by:
getUserDefinedFunction
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getUserDefinedFunctionValidation
public GetUserDefinedFunctionValidationResponse getUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest request)
Description copied from interface:DataIntegration
Retrieves a UserDefinedFunction validation using the specified identifier.- Specified by:
getUserDefinedFunctionValidation
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:DataIntegration
Retrieves the status of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkspace
public GetWorkspaceResponse getWorkspace(GetWorkspaceRequest request)
Description copied from interface:DataIntegration
Retrieves a Data Integration workspace using the specified identifier.- Specified by:
getWorkspace
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listApplications
public ListApplicationsResponse listApplications(ListApplicationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of applications and provides options to filter the list.- Specified by:
listApplications
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConnectionValidations
public ListConnectionValidationsResponse listConnectionValidations(ListConnectionValidationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of connection validations within the specified workspace.- Specified by:
listConnectionValidations
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConnections
public ListConnectionsResponse listConnections(ListConnectionsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of all connections.- Specified by:
listConnections
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCopyObjectRequests
public ListCopyObjectRequestsResponse listCopyObjectRequests(ListCopyObjectRequestsRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the list of copy object requests.- Specified by:
listCopyObjectRequests
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataAssets
public ListDataAssetsResponse listDataAssets(ListDataAssetsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of all data asset summaries.- Specified by:
listDataAssets
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataEntities
public ListDataEntitiesResponse listDataEntities(ListDataEntitiesRequest request)
Description copied from interface:DataIntegration
Lists a summary of data entities from the data asset using the specified connection.- Specified by:
listDataEntities
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataFlowValidations
public ListDataFlowValidationsResponse listDataFlowValidations(ListDataFlowValidationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of data flow validations within the specified workspace.- Specified by:
listDataFlowValidations
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataFlows
public ListDataFlowsResponse listDataFlows(ListDataFlowsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of data flows in a project or folder.- Specified by:
listDataFlows
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDependentObjects
public ListDependentObjectsResponse listDependentObjects(ListDependentObjectsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of all dependent objects for a specific application.- Specified by:
listDependentObjects
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDisApplicationTaskRunLineages
public ListDisApplicationTaskRunLineagesResponse listDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to list Task Run Lineages within a given time window.- Specified by:
listDisApplicationTaskRunLineages
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDisApplications
public ListDisApplicationsResponse listDisApplications(ListDisApplicationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.- Specified by:
listDisApplications
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listExportRequests
public ListExportRequestsResponse listExportRequests(ListExportRequestsRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the list of export object requests.- Specified by:
listExportRequests
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listExternalPublicationValidations
public ListExternalPublicationValidationsResponse listExternalPublicationValidations(ListExternalPublicationValidationsRequest request)
Description copied from interface:DataIntegration
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.- Specified by:
listExternalPublicationValidations
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listExternalPublications
public ListExternalPublicationsResponse listExternalPublications(ListExternalPublicationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of external publications in an application and provides options to filter the list.- Specified by:
listExternalPublications
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFolders
public ListFoldersResponse listFolders(ListFoldersRequest request)
Description copied from interface:DataIntegration
Retrieves a list of folders in a project and provides options to filter the list.- Specified by:
listFolders
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFunctionLibraries
public ListFunctionLibrariesResponse listFunctionLibraries(ListFunctionLibrariesRequest request)
Description copied from interface:DataIntegration
Retrieves a list of function libraries in a project and provides options to filter the list.- Specified by:
listFunctionLibraries
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listImportRequests
public ListImportRequestsResponse listImportRequests(ListImportRequestsRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the list of import object requests.- Specified by:
listImportRequests
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPatchChanges
public ListPatchChangesResponse listPatchChanges(ListPatchChangesRequest request)
Description copied from interface:DataIntegration
Retrieves a list of patches in an application and provides options to filter the list.- Specified by:
listPatchChanges
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPatches
public ListPatchesResponse listPatches(ListPatchesRequest request)
Description copied from interface:DataIntegration
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.
- Specified by:
listPatches
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPipelineValidations
public ListPipelineValidationsResponse listPipelineValidations(ListPipelineValidationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of pipeline validations within the specified workspace.- Specified by:
listPipelineValidations
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPipelines
public ListPipelinesResponse listPipelines(ListPipelinesRequest request)
Description copied from interface:DataIntegration
Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.- Specified by:
listPipelines
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listProjects
public ListProjectsResponse listProjects(ListProjectsRequest request)
Description copied from interface:DataIntegration
Retrieves a lists of projects in a workspace and provides options to filter the list.- Specified by:
listProjects
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPublishedObjects
public ListPublishedObjectsResponse listPublishedObjects(ListPublishedObjectsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of all the published objects for a specified application.- Specified by:
listPublishedObjects
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listReferences
public ListReferencesResponse listReferences(ListReferencesRequest request)
Description copied from interface:DataIntegration
Retrieves a list of references in an application.Reference objects are created when dataflows and tasks use objects, such as data assets and connections.
- Specified by:
listReferences
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRuntimeOperators
public ListRuntimeOperatorsResponse listRuntimeOperators(ListRuntimeOperatorsRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to list runtime operators with filtering options- Specified by:
listRuntimeOperators
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRuntimePipelines
public ListRuntimePipelinesResponse listRuntimePipelines(ListRuntimePipelinesRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to list runtime pipelines with filtering options- Specified by:
listRuntimePipelines
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSchedules
public ListSchedulesResponse listSchedules(ListSchedulesRequest request)
Description copied from interface:DataIntegration
Use this endpoint to list schedules.- Specified by:
listSchedules
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSchemas
public ListSchemasResponse listSchemas(ListSchemasRequest request)
Description copied from interface:DataIntegration
Retrieves a list of all the schemas that can be accessed using the specified connection.- Specified by:
listSchemas
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaskRunLineages
public ListTaskRunLineagesResponse listTaskRunLineages(ListTaskRunLineagesRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to list Task Run Lineages within a given time window.- Specified by:
listTaskRunLineages
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaskRunLogs
public ListTaskRunLogsResponse listTaskRunLogs(ListTaskRunLogsRequest request)
Description copied from interface:DataIntegration
Gets log entries for task runs using its key.- Specified by:
listTaskRunLogs
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaskRuns
public ListTaskRunsResponse listTaskRuns(ListTaskRunsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of task runs and provides options to filter the list.- Specified by:
listTaskRuns
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaskSchedules
public ListTaskSchedulesResponse listTaskSchedules(ListTaskSchedulesRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to get the list of all the TaskSchedule objects.- Specified by:
listTaskSchedules
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTaskValidations
public ListTaskValidationsResponse listTaskValidations(ListTaskValidationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of task validations within the specified workspace.- Specified by:
listTaskValidations
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTasks
public ListTasksResponse listTasks(ListTasksRequest request)
Description copied from interface:DataIntegration
Retrieves a list of all tasks in a specified project or folder.- Specified by:
listTasks
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTemplates
public ListTemplatesResponse listTemplates(ListTemplatesRequest request)
Description copied from interface:DataIntegration
This endpoint can be used to list application templates with filtering options.- Specified by:
listTemplates
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUserDefinedFunctionValidations
public ListUserDefinedFunctionValidationsResponse listUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.- Specified by:
listUserDefinedFunctionValidations
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listUserDefinedFunctions
public ListUserDefinedFunctionsResponse listUserDefinedFunctions(ListUserDefinedFunctionsRequest request)
Description copied from interface:DataIntegration
Retrieves a list of UserDefinedFunctions in a function library.- Specified by:
listUserDefinedFunctions
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:DataIntegration
Retrieves a paginated list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:DataIntegration
Retrieves a paginated list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:DataIntegration
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkspaces
public ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest request)
Description copied from interface:DataIntegration
Retrieves a list of Data Integration workspaces.- Specified by:
listWorkspaces
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startWorkspace
public StartWorkspaceResponse startWorkspace(StartWorkspaceRequest request)
Description copied from interface:DataIntegration
Starts a workspace.- Specified by:
startWorkspace
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopWorkspace
public StopWorkspaceResponse stopWorkspace(StopWorkspaceRequest request)
Description copied from interface:DataIntegration
Stops a workspace.- Specified by:
stopWorkspace
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateApplication
public UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)
Description copied from interface:DataIntegration
Updates an application.- Specified by:
updateApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateApplicationDetailedDescription
public UpdateApplicationDetailedDescriptionResponse updateApplicationDetailedDescription(UpdateApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Updates the detailed description of an Application.- Specified by:
updateApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConnection
public UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Description copied from interface:DataIntegration
Updates a connection under a data asset.- Specified by:
updateConnection
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCopyObjectRequest
public UpdateCopyObjectRequestResponse updateCopyObjectRequest(UpdateCopyObjectRequestRequest request)
Description copied from interface:DataIntegration
Updates the status of a copy object request.- Specified by:
updateCopyObjectRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataAsset
public UpdateDataAssetResponse updateDataAsset(UpdateDataAssetRequest request)
Description copied from interface:DataIntegration
Updates a specific data asset with default connection.- Specified by:
updateDataAsset
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataFlow
public UpdateDataFlowResponse updateDataFlow(UpdateDataFlowRequest request)
Description copied from interface:DataIntegration
Updates a specific data flow.- Specified by:
updateDataFlow
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDisApplication
public UpdateDisApplicationResponse updateDisApplication(UpdateDisApplicationRequest request)
Description copied from interface:DataIntegration
Updates a DIS Application.- Specified by:
updateDisApplication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDisApplicationDetailedDescription
public UpdateDisApplicationDetailedDescriptionResponse updateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest request)
Description copied from interface:DataIntegration
Updates the detailed description of an Application.- Specified by:
updateDisApplicationDetailedDescription
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateExportRequest
public UpdateExportRequestResponse updateExportRequest(UpdateExportRequestRequest request)
Description copied from interface:DataIntegration
Updates the status of a export object request.- Specified by:
updateExportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateExternalPublication
public UpdateExternalPublicationResponse updateExternalPublication(UpdateExternalPublicationRequest request)
Description copied from interface:DataIntegration
Updates the external publication object.- Specified by:
updateExternalPublication
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateFolder
public UpdateFolderResponse updateFolder(UpdateFolderRequest request)
Description copied from interface:DataIntegration
Updates a specific folder.- Specified by:
updateFolder
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateFunctionLibrary
public UpdateFunctionLibraryResponse updateFunctionLibrary(UpdateFunctionLibraryRequest request)
Description copied from interface:DataIntegration
Updates a specific Function Library.- Specified by:
updateFunctionLibrary
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateImportRequest
public UpdateImportRequestResponse updateImportRequest(UpdateImportRequestRequest request)
Description copied from interface:DataIntegration
Updates the status of a import object request.- Specified by:
updateImportRequest
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePipeline
public UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request)
Description copied from interface:DataIntegration
Updates a specific pipeline.- Specified by:
updatePipeline
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateProject
public UpdateProjectResponse updateProject(UpdateProjectRequest request)
Description copied from interface:DataIntegration
Updates a specific project.- Specified by:
updateProject
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateReference
public UpdateReferenceResponse updateReference(UpdateReferenceRequest request)
Description copied from interface:DataIntegration
Updates the application references.For example, to map a data asset to a different target object.
- Specified by:
updateReference
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSchedule
public UpdateScheduleResponse updateSchedule(UpdateScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint used to update the schedule- Specified by:
updateSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTask
public UpdateTaskResponse updateTask(UpdateTaskRequest request)
Description copied from interface:DataIntegration
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.- Specified by:
updateTask
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTaskRun
public UpdateTaskRunResponse updateTaskRun(UpdateTaskRunRequest request)
Description copied from interface:DataIntegration
Updates the status of the task run.For example, aborts a task run.
- Specified by:
updateTaskRun
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTaskSchedule
public UpdateTaskScheduleResponse updateTaskSchedule(UpdateTaskScheduleRequest request)
Description copied from interface:DataIntegration
Endpoint used to update the TaskSchedule- Specified by:
updateTaskSchedule
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateUserDefinedFunction
public UpdateUserDefinedFunctionResponse updateUserDefinedFunction(UpdateUserDefinedFunctionRequest request)
Description copied from interface:DataIntegration
Updates a specific UserDefinedFunction.- Specified by:
updateUserDefinedFunction
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateWorkspace
public UpdateWorkspaceResponse updateWorkspace(UpdateWorkspaceRequest request)
Description copied from interface:DataIntegration
Updates the specified Data Integration workspace.- Specified by:
updateWorkspace
in interfaceDataIntegration
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DataIntegrationWaiters getWaiters()
Description copied from interface:DataIntegration
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDataIntegration
- Returns:
- The service waiters.
-
getPaginators
public DataIntegrationPaginators getPaginators()
Description copied from interface:DataIntegration
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.- Specified by:
getPaginators
in interfaceDataIntegration
- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-