@Generated(value="OracleSDKGenerator", comments="API Version: 20210217") public interface DataConnectivityManagement extends AutoCloseable
Use the Data Connectivity Management Service APIs to perform common extract, load, and transform (ETL) tasks. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
ChangeEndpointCompartmentResponse |
changeEndpointCompartment(ChangeEndpointCompartmentRequest request)
The endpoint will be moved to the specified compartment.
|
ChangeRegistryCompartmentResponse |
changeRegistryCompartment(ChangeRegistryCompartmentRequest request)
The registry will be moved to the specified compartment.
|
CreateAttachDataAssetResponse |
createAttachDataAsset(CreateAttachDataAssetRequest request)
Attaches a list of data assets to the given endpoint.
|
CreateConnectionResponse |
createConnection(CreateConnectionRequest request)
Creates a connection under an existing data asset.
|
CreateConnectionValidationResponse |
createConnectionValidation(CreateConnectionValidationRequest request)
Creates a connection validation.
|
CreateConnectivityValidationResponse |
createConnectivityValidation(CreateConnectivityValidationRequest request)
This endpoint is used to trigger validation of dataAsset, connection, schema, entity,
dataOperationConfig
|
CreateDataAssetResponse |
createDataAsset(CreateDataAssetRequest request)
Creates a data asset with default connection.
|
CreateDataPreviewResponse |
createDataPreview(CreateDataPreviewRequest request)
Provide data preview on live schema.
|
CreateDataProfileResponse |
createDataProfile(CreateDataProfileRequest request)
Execute data profiling on live schema.
|
CreateDeReferenceArtifactResponse |
createDeReferenceArtifact(CreateDeReferenceArtifactRequest request)
Dereferenced a dcms artifact.
|
CreateDetachDataAssetResponse |
createDetachDataAsset(CreateDetachDataAssetRequest request)
Detaches a list of data assets to the given endpoint.
|
CreateEndpointResponse |
createEndpoint(CreateEndpointRequest request)
Creates a new Data Connectivity Management endpoint ready to perform data connectivity.
|
CreateEntityShapeResponse |
createEntityShape(CreateEntityShapeRequest request)
Creates the data entity shape using the shape from the data asset.
|
CreateExecuteOperationJobResponse |
createExecuteOperationJob(CreateExecuteOperationJobRequest request)
Call the operation to execute
|
CreateFolderResponse |
createFolder(CreateFolderRequest request)
Creates a folder under a specified registry.
|
CreateFullPushDownTaskResponse |
createFullPushDownTask(CreateFullPushDownTaskRequest request)
This endpoint is used to create a connectivity task (such as PushdownTask).
|
CreateReferenceArtifactResponse |
createReferenceArtifact(CreateReferenceArtifactRequest request)
Reference a data asset.
|
CreateRegistryResponse |
createRegistry(CreateRegistryRequest request)
Creates a new Data Connectivity Management registry ready to perform data connectivity
management.
|
CreateTestNetworkConnectivityResponse |
createTestNetworkConnectivity(CreateTestNetworkConnectivityRequest request)
Execute network validation on the selected data assets associated with the provided private
endpoint.
|
DeleteConnectionResponse |
deleteConnection(DeleteConnectionRequest request)
Removes a connection using the specified identifier.
|
DeleteDataAssetResponse |
deleteDataAsset(DeleteDataAssetRequest request)
Removes a data asset using the specified identifier.
|
DeleteEndpointResponse |
deleteEndpoint(DeleteEndpointRequest request)
Deletes a Data Connectivity Management endpoint resource by its identifier.
|
DeleteFolderResponse |
deleteFolder(DeleteFolderRequest request)
Removes a folder using the specified identifier.
|
DeleteNetworkConnectivityStatusResponse |
deleteNetworkConnectivityStatus(DeleteNetworkConnectivityStatusRequest request)
This api is used to delete a persisted NetworkValidationStatus by its key
|
DeleteRegistryResponse |
deleteRegistry(DeleteRegistryRequest request)
Deletes a Data Connectivity Management registry resource by its identifier.
|
DeriveEntitiesResponse |
deriveEntities(DeriveEntitiesRequest request)
Get the Derived Entities from the EntityFlowMode and reference key of DataObject
|
GetConnectionResponse |
getConnection(GetConnectionRequest request)
Retrieves the connection details using the specified identifier.
|
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.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetEndpointResponse |
getEndpoint(GetEndpointRequest request)
Gets a Data Connectivity Management endpoint by its identifier.
|
GetEngineConfigurationsResponse |
getEngineConfigurations(GetEngineConfigurationsRequest request)
This endpoint is used to fetch connector-specific engine configurations.
|
GetExecuteOperationJobResponse |
getExecuteOperationJob(GetExecuteOperationJobRequest request)
Get the status or the result of the execution.
|
GetFolderResponse |
getFolder(GetFolderRequest request)
Retrieves the folder details using the specified identifier.
|
GetNetworkConnectivityStatusResponse |
getNetworkConnectivityStatus(GetNetworkConnectivityStatusRequest request)
Get the status of network reachability check, with the timestamp of when the status was last
checked, for a given PrivateEndpoint-DataAsset pair.
|
GetOperationResponse |
getOperation(GetOperationRequest request)
Retrieves the details of operation with the given resource name.
|
DataConnectivityManagementPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetRegistryResponse |
getRegistry(GetRegistryRequest request)
Retrieves a Data Connectivity Management registry using the specified identifier.
|
GetSchemaResponse |
getSchema(GetSchemaRequest request)
Retrieves a schema that can be accessed using the specified connection.
|
GetTypeResponse |
getType(GetTypeRequest request)
This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry.
|
DataConnectivityManagementWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
|
ListConnectionsResponse |
listConnections(ListConnectionsRequest request)
Retrieves a list of all connections.
|
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.
|
ListEndpointsResponse |
listEndpoints(ListEndpointsRequest request)
Returns a list of Data Connectivity Management endpoints.
|
ListFoldersResponse |
listFolders(ListFoldersRequest request)
Retrieves a list of all the folders.
|
ListOperationsResponse |
listOperations(ListOperationsRequest request)
Lists the summary of operations that are present in the schema, identified by the schema
name.
|
ListReferenceArtifactsResponse |
listReferenceArtifacts(ListReferenceArtifactsRequest request)
Retrieves a list of all reference info of a dcms artifact.
|
ListRegistriesResponse |
listRegistries(ListRegistriesRequest request)
Retrieves a list of Data Connectivity Management registries.
|
ListSchemasResponse |
listSchemas(ListSchemasRequest request)
Retrieves a list of all the schemas that can be accessed using the specified connection.
|
ListTypesResponse |
listTypes(ListTypesRequest request)
This endpoint retrieves a list of all the supported connector types.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for a given work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a (paginated) list of logs for a given work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateConnectionResponse |
updateConnection(UpdateConnectionRequest request)
Updates a connection under a data asset.
|
UpdateDataAssetResponse |
updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset with default connection.
|
UpdateEndpointResponse |
updateEndpoint(UpdateEndpointRequest request)
Updates the Data Connectivity Management endpoint.
|
UpdateFolderResponse |
updateFolder(UpdateFolderRequest request)
Updates a folder under a specified registry.
|
UpdateRegistryResponse |
updateRegistry(UpdateRegistryRequest request)
Updates the Data Connectivity Management Registry.
|
ValidateDataAssetNetworkReachablityResponse |
validateDataAssetNetworkReachablity(ValidateDataAssetNetworkReachablityRequest request)
Validates the dataAsset network reachability.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.ChangeEndpointCompartmentResponse changeEndpointCompartment(ChangeEndpointCompartmentRequest request)
The endpoint will be moved to the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeEndpointCompartment API.
ChangeRegistryCompartmentResponse changeRegistryCompartment(ChangeRegistryCompartmentRequest request)
The registry will be moved to the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeRegistryCompartment API.
CreateAttachDataAssetResponse createAttachDataAsset(CreateAttachDataAssetRequest request)
Attaches a list of data assets to the given endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateAttachDataAsset API.
CreateConnectionResponse createConnection(CreateConnectionRequest request)
Creates a connection under an existing data asset.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateConnection API.
CreateConnectionValidationResponse createConnectionValidation(CreateConnectionValidationRequest request)
Creates a connection validation.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateConnectionValidation API.
CreateConnectivityValidationResponse createConnectivityValidation(CreateConnectivityValidationRequest request)
This endpoint is used to trigger validation of dataAsset, connection, schema, entity, dataOperationConfig
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateConnectivityValidation API.
CreateDataAssetResponse createDataAsset(CreateDataAssetRequest request)
Creates a data asset with default connection.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDataAsset API.
CreateDataPreviewResponse createDataPreview(CreateDataPreviewRequest request)
Provide data preview on live schema.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDataPreview API.
CreateDataProfileResponse createDataProfile(CreateDataProfileRequest request)
Execute data profiling on live schema.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDataProfile API.
CreateDeReferenceArtifactResponse createDeReferenceArtifact(CreateDeReferenceArtifactRequest request)
Dereferenced a dcms artifact.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDeReferenceArtifact API.
CreateDetachDataAssetResponse createDetachDataAsset(CreateDetachDataAssetRequest request)
Detaches a list of data assets to the given endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateDetachDataAsset API.
CreateEndpointResponse createEndpoint(CreateEndpointRequest request)
Creates a new Data Connectivity Management endpoint ready to perform data connectivity.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateEndpoint API.
CreateEntityShapeResponse createEntityShape(CreateEntityShapeRequest request)
Creates the data entity shape using the shape from the data asset.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateEntityShape API.
CreateExecuteOperationJobResponse createExecuteOperationJob(CreateExecuteOperationJobRequest request)
Call the operation to execute
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateExecuteOperationJob API.
CreateFolderResponse createFolder(CreateFolderRequest request)
Creates a folder under a specified registry.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateFolder API.
CreateFullPushDownTaskResponse createFullPushDownTask(CreateFullPushDownTaskRequest request)
This endpoint is used to create a connectivity task (such as PushdownTask).
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateFullPushDownTask API.
CreateReferenceArtifactResponse createReferenceArtifact(CreateReferenceArtifactRequest request)
Reference a data asset.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateReferenceArtifact API.
CreateRegistryResponse createRegistry(CreateRegistryRequest request)
Creates a new Data Connectivity Management registry ready to perform data connectivity management.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateRegistry API.
CreateTestNetworkConnectivityResponse createTestNetworkConnectivity(CreateTestNetworkConnectivityRequest request)
Execute network validation on the selected data assets associated with the provided private endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateTestNetworkConnectivity API.
DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Removes a connection using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteConnection API.
DeleteDataAssetResponse deleteDataAsset(DeleteDataAssetRequest request)
Removes a data asset using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteDataAsset API.
DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest request)
Deletes a Data Connectivity Management endpoint resource by its identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteEndpoint API.
DeleteFolderResponse deleteFolder(DeleteFolderRequest request)
Removes a folder using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteFolder API.
DeleteNetworkConnectivityStatusResponse deleteNetworkConnectivityStatus(DeleteNetworkConnectivityStatusRequest request)
This api is used to delete a persisted NetworkValidationStatus by its key
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteNetworkConnectivityStatus API.
DeleteRegistryResponse deleteRegistry(DeleteRegistryRequest request)
Deletes a Data Connectivity Management registry resource by its identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteRegistry API.
DeriveEntitiesResponse deriveEntities(DeriveEntitiesRequest request)
Get the Derived Entities from the EntityFlowMode and reference key of DataObject
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeriveEntities API.
GetConnectionResponse getConnection(GetConnectionRequest request)
Retrieves the connection details using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetConnection API.
GetDataAssetResponse getDataAsset(GetDataAssetRequest request)
Retrieves details of a data asset using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDataAsset API.
GetDataEntityResponse getDataEntity(GetDataEntityRequest request)
Retrieves the data entity details with the given name from live schema.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetDataEntity API.
GetEndpointResponse getEndpoint(GetEndpointRequest request)
Gets a Data Connectivity Management endpoint by its identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetEndpoint API.
GetEngineConfigurationsResponse getEngineConfigurations(GetEngineConfigurationsRequest request)
This endpoint is used to fetch connector-specific engine configurations.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetEngineConfigurations API.
GetExecuteOperationJobResponse getExecuteOperationJob(GetExecuteOperationJobRequest request)
Get the status or the result of the execution.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetExecuteOperationJob API.
GetFolderResponse getFolder(GetFolderRequest request)
Retrieves the folder details using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetFolder API.
GetNetworkConnectivityStatusResponse getNetworkConnectivityStatus(GetNetworkConnectivityStatusRequest request)
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 sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetNetworkConnectivityStatus API.
GetOperationResponse getOperation(GetOperationRequest request)
Retrieves the details of operation with the given resource name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetOperation API.
GetRegistryResponse getRegistry(GetRegistryRequest request)
Retrieves a Data Connectivity Management registry using the specified identifier.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRegistry API.
GetSchemaResponse getSchema(GetSchemaRequest request)
Retrieves a schema that can be accessed using the specified connection.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSchema API.
GetTypeResponse getType(GetTypeRequest request)
This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetType API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ListConnectionsResponse listConnections(ListConnectionsRequest request)
Retrieves a list of all connections.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListConnections API.
ListDataAssetsResponse listDataAssets(ListDataAssetsRequest request)
Retrieves a list of all data asset summaries.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataAssets API.
ListDataEntitiesResponse listDataEntities(ListDataEntitiesRequest request)
Lists a summary of data entities from the data asset using the specified connection.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListDataEntities API.
ListEndpointsResponse listEndpoints(ListEndpointsRequest request)
Returns a list of Data Connectivity Management endpoints.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListEndpoints API.
ListFoldersResponse listFolders(ListFoldersRequest request)
Retrieves a list of all the folders.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListFolders API.
ListOperationsResponse listOperations(ListOperationsRequest request)
Lists the summary of operations that are present in the schema, identified by the schema name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListOperations API.
ListReferenceArtifactsResponse listReferenceArtifacts(ListReferenceArtifactsRequest request)
Retrieves a list of all reference info of a dcms artifact.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListReferenceArtifacts API.
ListRegistriesResponse listRegistries(ListRegistriesRequest request)
Retrieves a list of Data Connectivity Management registries.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRegistries API.
ListSchemasResponse listSchemas(ListSchemasRequest request)
Retrieves a list of all the schemas that can be accessed using the specified connection.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSchemas API.
ListTypesResponse listTypes(ListTypesRequest request)
This endpoint retrieves a list of all the supported connector types.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListTypes API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequests API.
UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Updates a connection under a data asset.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateConnection API.
UpdateDataAssetResponse updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset with default connection.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateDataAsset API.
UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest request)
Updates the Data Connectivity Management endpoint.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateEndpoint API.
UpdateFolderResponse updateFolder(UpdateFolderRequest request)
Updates a folder under a specified registry.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateFolder API.
UpdateRegistryResponse updateRegistry(UpdateRegistryRequest request)
Updates the Data Connectivity Management Registry.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateRegistry API.
ValidateDataAssetNetworkReachablityResponse validateDataAssetNetworkReachablity(ValidateDataAssetNetworkReachablityRequest request)
Validates the dataAsset network reachability.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation will not retry by default, users
can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
enable retries for it. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ValidateDataAssetNetworkReachablity API.
DataConnectivityManagementWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
DataConnectivityManagementPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
Copyright © 2016–2023. All rights reserved.