@Generated(value="OracleSDKGenerator", comments="API Version: 20210217") public interface DataConnectivityManagementAsync extends AutoCloseable
Use the Data Connectivity Management Service APIs to perform common extract, load, and transform (ETL) tasks.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.Future<ChangeEndpointCompartmentResponse> changeEndpointCompartment(ChangeEndpointCompartmentRequest request, AsyncHandler<ChangeEndpointCompartmentRequest,ChangeEndpointCompartmentResponse> handler)
The endpoint will be moved to the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeRegistryCompartmentResponse> changeRegistryCompartment(ChangeRegistryCompartmentRequest request, AsyncHandler<ChangeRegistryCompartmentRequest,ChangeRegistryCompartmentResponse> handler)
The registry will be moved to the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAttachDataAssetResponse> createAttachDataAsset(CreateAttachDataAssetRequest request, AsyncHandler<CreateAttachDataAssetRequest,CreateAttachDataAssetResponse> handler)
Attaches a list of data assets to the given endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateConnectionResponse> createConnection(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)
Creates a connection under an existing data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateConnectionValidationResponse> createConnectionValidation(CreateConnectionValidationRequest request, AsyncHandler<CreateConnectionValidationRequest,CreateConnectionValidationResponse> handler)
Creates a connection validation.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateConnectivityValidationResponse> createConnectivityValidation(CreateConnectivityValidationRequest request, AsyncHandler<CreateConnectivityValidationRequest,CreateConnectivityValidationResponse> handler)
This endpoint is used to trigger validation of dataAsset, connection, schema, entity, dataOperationConfig
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataAssetResponse> createDataAsset(CreateDataAssetRequest request, AsyncHandler<CreateDataAssetRequest,CreateDataAssetResponse> handler)
Creates a data asset with default connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataPreviewResponse> createDataPreview(CreateDataPreviewRequest request, AsyncHandler<CreateDataPreviewRequest,CreateDataPreviewResponse> handler)
Provide data preview on live schema.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataProfileResponse> createDataProfile(CreateDataProfileRequest request, AsyncHandler<CreateDataProfileRequest,CreateDataProfileResponse> handler)
Execute data profiling on live schema.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDeReferenceArtifactResponse> createDeReferenceArtifact(CreateDeReferenceArtifactRequest request, AsyncHandler<CreateDeReferenceArtifactRequest,CreateDeReferenceArtifactResponse> handler)
Dereferenced a dcms artifact.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDetachDataAssetResponse> createDetachDataAsset(CreateDetachDataAssetRequest request, AsyncHandler<CreateDetachDataAssetRequest,CreateDetachDataAssetResponse> handler)
Detaches a list of data assets to the given endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateEndpointResponse> createEndpoint(CreateEndpointRequest request, AsyncHandler<CreateEndpointRequest,CreateEndpointResponse> handler)
Creates a new Data Connectivity Management endpoint ready to perform data connectivity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateEntityShapeResponse> createEntityShape(CreateEntityShapeRequest request, AsyncHandler<CreateEntityShapeRequest,CreateEntityShapeResponse> handler)
Creates the data entity shape using the shape from the data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateExecuteOperationJobResponse> createExecuteOperationJob(CreateExecuteOperationJobRequest request, AsyncHandler<CreateExecuteOperationJobRequest,CreateExecuteOperationJobResponse> handler)
Call the operation to execute
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateFolderResponse> createFolder(CreateFolderRequest request, AsyncHandler<CreateFolderRequest,CreateFolderResponse> handler)
Creates a folder under a specified registry.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateFullPushDownTaskResponse> createFullPushDownTask(CreateFullPushDownTaskRequest request, AsyncHandler<CreateFullPushDownTaskRequest,CreateFullPushDownTaskResponse> handler)
This endpoint is used to create a connectivity task (such as PushdownTask).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateReferenceArtifactResponse> createReferenceArtifact(CreateReferenceArtifactRequest request, AsyncHandler<CreateReferenceArtifactRequest,CreateReferenceArtifactResponse> handler)
Reference a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateRegistryResponse> createRegistry(CreateRegistryRequest request, AsyncHandler<CreateRegistryRequest,CreateRegistryResponse> handler)
Creates a new Data Connectivity Management registry ready to perform data connectivity management.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateTestNetworkConnectivityResponse> createTestNetworkConnectivity(CreateTestNetworkConnectivityRequest request, AsyncHandler<CreateTestNetworkConnectivityRequest,CreateTestNetworkConnectivityResponse> handler)
Execute network validation on the selected data assets associated with the provided private endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)
Removes a connection using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDataAssetResponse> deleteDataAsset(DeleteDataAssetRequest request, AsyncHandler<DeleteDataAssetRequest,DeleteDataAssetResponse> handler)
Removes a data asset using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest request, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResponse> handler)
Deletes a Data Connectivity Management endpoint resource by its identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteFolderResponse> deleteFolder(DeleteFolderRequest request, AsyncHandler<DeleteFolderRequest,DeleteFolderResponse> handler)
Removes a folder using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteNetworkConnectivityStatusResponse> deleteNetworkConnectivityStatus(DeleteNetworkConnectivityStatusRequest request, AsyncHandler<DeleteNetworkConnectivityStatusRequest,DeleteNetworkConnectivityStatusResponse> handler)
This api is used to delete a persisted NetworkValidationStatus by its key
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteRegistryResponse> deleteRegistry(DeleteRegistryRequest request, AsyncHandler<DeleteRegistryRequest,DeleteRegistryResponse> handler)
Deletes a Data Connectivity Management registry resource by its identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeriveEntitiesResponse> deriveEntities(DeriveEntitiesRequest request, AsyncHandler<DeriveEntitiesRequest,DeriveEntitiesResponse> handler)
Get the Derived Entities from the EntityFlowMode and reference key of DataObject
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetConnectionResponse> getConnection(GetConnectionRequest request, AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)
Retrieves the connection details using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataAssetResponse> getDataAsset(GetDataAssetRequest request, AsyncHandler<GetDataAssetRequest,GetDataAssetResponse> handler)
Retrieves details of a data asset using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataEntityResponse> getDataEntity(GetDataEntityRequest request, AsyncHandler<GetDataEntityRequest,GetDataEntityResponse> handler)
Retrieves the data entity details with the given name from live schema.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetEndpointResponse> getEndpoint(GetEndpointRequest request, AsyncHandler<GetEndpointRequest,GetEndpointResponse> handler)
Gets a Data Connectivity Management endpoint by its identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetEngineConfigurationsResponse> getEngineConfigurations(GetEngineConfigurationsRequest request, AsyncHandler<GetEngineConfigurationsRequest,GetEngineConfigurationsResponse> handler)
This endpoint is used to fetch connector-specific engine configurations.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetExecuteOperationJobResponse> getExecuteOperationJob(GetExecuteOperationJobRequest request, AsyncHandler<GetExecuteOperationJobRequest,GetExecuteOperationJobResponse> handler)
Get the status or the result of the execution.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetFolderResponse> getFolder(GetFolderRequest request, AsyncHandler<GetFolderRequest,GetFolderResponse> handler)
Retrieves the folder details using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetNetworkConnectivityStatusResponse> getNetworkConnectivityStatus(GetNetworkConnectivityStatusRequest request, AsyncHandler<GetNetworkConnectivityStatusRequest,GetNetworkConnectivityStatusResponse> handler)
Get the status of network reachability check, with the timestamp of when the status was last checked, for a given PrivateEndpoint-DataAsset pair.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetOperationResponse> getOperation(GetOperationRequest request, AsyncHandler<GetOperationRequest,GetOperationResponse> handler)
Retrieves the details of operation with the given resource name.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetRegistryResponse> getRegistry(GetRegistryRequest request, AsyncHandler<GetRegistryRequest,GetRegistryResponse> handler)
Retrieves a Data Connectivity Management registry using the specified identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetSchemaResponse> getSchema(GetSchemaRequest request, AsyncHandler<GetSchemaRequest,GetSchemaResponse> handler)
Retrieves a schema that can be accessed using the specified connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTypeResponse> getType(GetTypeRequest request, AsyncHandler<GetTypeRequest,GetTypeResponse> handler)
This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListConnectionsResponse> listConnections(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)
Retrieves a list of all connections.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataAssetsResponse> listDataAssets(ListDataAssetsRequest request, AsyncHandler<ListDataAssetsRequest,ListDataAssetsResponse> handler)
Retrieves a list of all data asset summaries.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataEntitiesResponse> listDataEntities(ListDataEntitiesRequest request, AsyncHandler<ListDataEntitiesRequest,ListDataEntitiesResponse> handler)
Lists a summary of data entities from the data asset using the specified connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListEndpointsResponse> listEndpoints(ListEndpointsRequest request, AsyncHandler<ListEndpointsRequest,ListEndpointsResponse> handler)
Returns a list of Data Connectivity Management endpoints.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListFoldersResponse> listFolders(ListFoldersRequest request, AsyncHandler<ListFoldersRequest,ListFoldersResponse> handler)
Retrieves a list of all the folders.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListOperationsResponse> listOperations(ListOperationsRequest request, AsyncHandler<ListOperationsRequest,ListOperationsResponse> handler)
Lists the summary of operations that are present in the schema, identified by the schema name.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListReferenceArtifactsResponse> listReferenceArtifacts(ListReferenceArtifactsRequest request, AsyncHandler<ListReferenceArtifactsRequest,ListReferenceArtifactsResponse> handler)
Retrieves a list of all reference info of a dcms artifact.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListRegistriesResponse> listRegistries(ListRegistriesRequest request, AsyncHandler<ListRegistriesRequest,ListRegistriesResponse> handler)
Retrieves a list of Data Connectivity Management registries.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListSchemasResponse> listSchemas(ListSchemasRequest request, AsyncHandler<ListSchemasRequest,ListSchemasResponse> handler)
Retrieves a list of all the schemas that can be accessed using the specified connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTypesResponse> listTypes(ListTypesRequest request, AsyncHandler<ListTypesRequest,ListTypesResponse> handler)
This endpoint retrieves a list of all the supported connector types.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Returns a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)
Updates a connection under a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDataAssetResponse> updateDataAsset(UpdateDataAssetRequest request, AsyncHandler<UpdateDataAssetRequest,UpdateDataAssetResponse> handler)
Updates a specific data asset with default connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest request, AsyncHandler<UpdateEndpointRequest,UpdateEndpointResponse> handler)
Updates the Data Connectivity Management endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateFolderResponse> updateFolder(UpdateFolderRequest request, AsyncHandler<UpdateFolderRequest,UpdateFolderResponse> handler)
Updates a folder under a specified registry.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateRegistryResponse> updateRegistry(UpdateRegistryRequest request, AsyncHandler<UpdateRegistryRequest,UpdateRegistryResponse> handler)
Updates the Data Connectivity Management Registry.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ValidateDataAssetNetworkReachablityResponse> validateDataAssetNetworkReachablity(ValidateDataAssetNetworkReachablityRequest request, AsyncHandler<ValidateDataAssetNetworkReachablityRequest,ValidateDataAssetNetworkReachablityResponse> handler)
Validates the dataAsset network reachability.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2023. All rights reserved.