com.oracle.bmc.dataconnectivity

Class DataConnectivityManagementClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.dataconnectivity.DataConnectivityManagementClient

All Implemented Interfaces:

DataConnectivityManagement, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210217")
public class DataConnectivityManagementClient
extends BaseSyncClient
implements DataConnectivityManagement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataConnectivityManagementClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for DataConnectivityManagement.

Constructor Summary

Constructors

Constructor and Description
DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
DataConnectivityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
DataConnectivityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
DataConnectivityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static DataConnectivityManagementClient.Builder	builder() Create a builder for this client.
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.
void	close()
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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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() Rebuild the backing HttpClient.
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’).
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.

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 com.oracle.bmc.dataconnectivity.DataConnectivityManagement

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DataConnectivityManagement.

Constructor Detail

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration,
                                                    ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration,
                                                    ClientConfigurator clientConfigurator,
                                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration,
                                                    ClientConfigurator clientConfigurator,
                                                    RequestSignerFactory defaultRequestSignerFactory,
                                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration,
                                                    ClientConfigurator clientConfigurator,
                                                    RequestSignerFactory defaultRequestSignerFactory,
                                                    List<ClientConfigurator> additionalClientConfigurators,
                                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.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)

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration,
                                                    ClientConfigurator clientConfigurator,
                                                    RequestSignerFactory defaultRequestSignerFactory,
                                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                                    List<ClientConfigurator> additionalClientConfigurators,
                                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.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

DataConnectivityManagementClient

@Deprecated
public DataConnectivityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                    ClientConfiguration configuration,
                                                    ClientConfigurator clientConfigurator,
                                                    RequestSignerFactory defaultRequestSignerFactory,
                                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                                    List<ClientConfigurator> additionalClientConfigurators,
                                                    String endpoint,
                                                    ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataConnectivityManagementClient.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 - DataConnectivityManagementClient.Builder.executorService

Method Detail

builder

public static DataConnectivityManagementClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DataConnectivityManagement

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 interface DataConnectivityManagement

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DataConnectivityManagement

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.

Specified by:

setRegion in interface DataConnectivityManagement

Parameters:

regionId - The public region ID.

changeEndpointCompartment

public ChangeEndpointCompartmentResponse changeEndpointCompartment(ChangeEndpointCompartmentRequest request)

Description copied from interface: DataConnectivityManagement

The endpoint will be moved to the specified compartment.

Specified by:

changeEndpointCompartment in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeRegistryCompartment

public ChangeRegistryCompartmentResponse changeRegistryCompartment(ChangeRegistryCompartmentRequest request)

Description copied from interface: DataConnectivityManagement

The registry will be moved to the specified compartment.

Specified by:

changeRegistryCompartment in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAttachDataAsset

public CreateAttachDataAssetResponse createAttachDataAsset(CreateAttachDataAssetRequest request)

Description copied from interface: DataConnectivityManagement

Attaches a list of data assets to the given endpoint.

Specified by:

createAttachDataAsset in interface DataConnectivityManagement

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: DataConnectivityManagement

Creates a connection under an existing data asset.

Specified by:

createConnection in interface DataConnectivityManagement

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: DataConnectivityManagement

Creates a connection validation.

Specified by:

createConnectionValidation in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createConnectivityValidation

public CreateConnectivityValidationResponse createConnectivityValidation(CreateConnectivityValidationRequest request)

Description copied from interface: DataConnectivityManagement

This endpoint is used to trigger validation of dataAsset, connection, schema, entity, dataOperationConfig

Specified by:

createConnectivityValidation in interface DataConnectivityManagement

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: DataConnectivityManagement

Creates a data asset with default connection.

Specified by:

createDataAsset in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDataPreview

public CreateDataPreviewResponse createDataPreview(CreateDataPreviewRequest request)

Description copied from interface: DataConnectivityManagement

Provide data preview on live schema.

Specified by:

createDataPreview in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDataProfile

public CreateDataProfileResponse createDataProfile(CreateDataProfileRequest request)

Description copied from interface: DataConnectivityManagement

Execute data profiling on live schema.

Specified by:

createDataProfile in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDeReferenceArtifact

public CreateDeReferenceArtifactResponse createDeReferenceArtifact(CreateDeReferenceArtifactRequest request)

Description copied from interface: DataConnectivityManagement

Dereferenced a dcms artifact.

Specified by:

createDeReferenceArtifact in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDetachDataAsset

public CreateDetachDataAssetResponse createDetachDataAsset(CreateDetachDataAssetRequest request)

Description copied from interface: DataConnectivityManagement

Detaches a list of data assets to the given endpoint.

Specified by:

createDetachDataAsset in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createEndpoint

public CreateEndpointResponse createEndpoint(CreateEndpointRequest request)

Description copied from interface: DataConnectivityManagement

Creates a new Data Connectivity Management endpoint ready to perform data connectivity.

Specified by:

createEndpoint in interface DataConnectivityManagement

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: DataConnectivityManagement

Creates the data entity shape using the shape from the data asset.

Specified by:

createEntityShape in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createExecuteOperationJob

public CreateExecuteOperationJobResponse createExecuteOperationJob(CreateExecuteOperationJobRequest request)

Description copied from interface: DataConnectivityManagement

Call the operation to execute

Specified by:

createExecuteOperationJob in interface DataConnectivityManagement

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: DataConnectivityManagement

Creates a folder under a specified registry.

Specified by:

createFolder in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createFullPushDownTask

public CreateFullPushDownTaskResponse createFullPushDownTask(CreateFullPushDownTaskRequest request)

Description copied from interface: DataConnectivityManagement

This endpoint is used to create a connectivity task (such as PushdownTask).

Specified by:

createFullPushDownTask in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createReferenceArtifact

public CreateReferenceArtifactResponse createReferenceArtifact(CreateReferenceArtifactRequest request)

Description copied from interface: DataConnectivityManagement

Reference a data asset.

Specified by:

createReferenceArtifact in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRegistry

public CreateRegistryResponse createRegistry(CreateRegistryRequest request)

Description copied from interface: DataConnectivityManagement

Creates a new Data Connectivity Management registry ready to perform data connectivity management.

Specified by:

createRegistry in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTestNetworkConnectivity

public CreateTestNetworkConnectivityResponse createTestNetworkConnectivity(CreateTestNetworkConnectivityRequest request)

Description copied from interface: DataConnectivityManagement

Execute network validation on the selected data assets associated with the provided private endpoint.

Specified by:

createTestNetworkConnectivity in interface DataConnectivityManagement

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: DataConnectivityManagement

Removes a connection using the specified identifier.

Specified by:

deleteConnection in interface DataConnectivityManagement

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: DataConnectivityManagement

Removes a data asset using the specified identifier.

Specified by:

deleteDataAsset in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteEndpoint

public DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest request)

Description copied from interface: DataConnectivityManagement

Deletes a Data Connectivity Management endpoint resource by its identifier.

Specified by:

deleteEndpoint in interface DataConnectivityManagement

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: DataConnectivityManagement

Removes a folder using the specified identifier.

Specified by:

deleteFolder in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteNetworkConnectivityStatus

public DeleteNetworkConnectivityStatusResponse deleteNetworkConnectivityStatus(DeleteNetworkConnectivityStatusRequest request)

Description copied from interface: DataConnectivityManagement

This api is used to delete a persisted NetworkValidationStatus by its key

Specified by:

deleteNetworkConnectivityStatus in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRegistry

public DeleteRegistryResponse deleteRegistry(DeleteRegistryRequest request)

Description copied from interface: DataConnectivityManagement

Deletes a Data Connectivity Management registry resource by its identifier.

Specified by:

deleteRegistry in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deriveEntities

public DeriveEntitiesResponse deriveEntities(DeriveEntitiesRequest request)

Description copied from interface: DataConnectivityManagement

Get the Derived Entities from the EntityFlowMode and reference key of DataObject

Specified by:

deriveEntities in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves the connection details using the specified identifier.

Specified by:

getConnection in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves details of a data asset using the specified identifier.

Specified by:

getDataAsset in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves the data entity details with the given name from live schema.

Specified by:

getDataEntity in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEndpoint

public GetEndpointResponse getEndpoint(GetEndpointRequest request)

Description copied from interface: DataConnectivityManagement

Gets a Data Connectivity Management endpoint by its identifier.

Specified by:

getEndpoint in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEngineConfigurations

public GetEngineConfigurationsResponse getEngineConfigurations(GetEngineConfigurationsRequest request)

Description copied from interface: DataConnectivityManagement

This endpoint is used to fetch connector-specific engine configurations.

Specified by:

getEngineConfigurations in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getExecuteOperationJob

public GetExecuteOperationJobResponse getExecuteOperationJob(GetExecuteOperationJobRequest request)

Description copied from interface: DataConnectivityManagement

Get the status or the result of the execution.

Specified by:

getExecuteOperationJob in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves the folder details using the specified identifier.

Specified by:

getFolder in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getNetworkConnectivityStatus

public GetNetworkConnectivityStatusResponse getNetworkConnectivityStatus(GetNetworkConnectivityStatusRequest request)

Description copied from interface: DataConnectivityManagement

Get the status of network reachability check, with the timestamp of when the status was last checked, for a given PrivateEndpoint-DataAsset pair.

Specified by:

getNetworkConnectivityStatus in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOperation

public GetOperationResponse getOperation(GetOperationRequest request)

Description copied from interface: DataConnectivityManagement

Retrieves the details of operation with the given resource name.

Specified by:

getOperation in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRegistry

public GetRegistryResponse getRegistry(GetRegistryRequest request)

Description copied from interface: DataConnectivityManagement

Retrieves a Data Connectivity Management registry using the specified identifier.

Specified by:

getRegistry in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves a schema that can be accessed using the specified connection.

Specified by:

getSchema in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getType

public GetTypeResponse getType(GetTypeRequest request)

Description copied from interface: DataConnectivityManagement

This endpoint retrieves dataAsset and connection attributes from DataAssetRegistry.

Specified by:

getType in interface DataConnectivityManagement

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: DataConnectivityManagement

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves a list of all connections.

Specified by:

listConnections in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves a list of all data asset summaries.

Specified by:

listDataAssets in interface DataConnectivityManagement

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: DataConnectivityManagement

Lists a summary of data entities from the data asset using the specified connection.

Specified by:

listDataEntities in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listEndpoints

public ListEndpointsResponse listEndpoints(ListEndpointsRequest request)

Description copied from interface: DataConnectivityManagement

Returns a list of Data Connectivity Management endpoints.

Specified by:

listEndpoints in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves a list of all the folders.

Specified by:

listFolders in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOperations

public ListOperationsResponse listOperations(ListOperationsRequest request)

Description copied from interface: DataConnectivityManagement

Lists the summary of operations that are present in the schema, identified by the schema name.

Specified by:

listOperations in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listReferenceArtifacts

public ListReferenceArtifactsResponse listReferenceArtifacts(ListReferenceArtifactsRequest request)

Description copied from interface: DataConnectivityManagement

Retrieves a list of all reference info of a dcms artifact.

Specified by:

listReferenceArtifacts in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRegistries

public ListRegistriesResponse listRegistries(ListRegistriesRequest request)

Description copied from interface: DataConnectivityManagement

Retrieves a list of Data Connectivity Management registries.

Specified by:

listRegistries in interface DataConnectivityManagement

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: DataConnectivityManagement

Retrieves a list of all the schemas that can be accessed using the specified connection.

Specified by:

listSchemas in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTypes

public ListTypesResponse listTypes(ListTypesRequest request)

Description copied from interface: DataConnectivityManagement

This endpoint retrieves a list of all the supported connector types.

Specified by:

listTypes in interface DataConnectivityManagement

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: DataConnectivityManagement

Returns a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface DataConnectivityManagement

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: DataConnectivityManagement

Returns a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface DataConnectivityManagement

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: DataConnectivityManagement

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DataConnectivityManagement

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: DataConnectivityManagement

Updates a connection under a data asset.

Specified by:

updateConnection in interface DataConnectivityManagement

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: DataConnectivityManagement

Updates a specific data asset with default connection.

Specified by:

updateDataAsset in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateEndpoint

public UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest request)

Description copied from interface: DataConnectivityManagement

Updates the Data Connectivity Management endpoint.

Specified by:

updateEndpoint in interface DataConnectivityManagement

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: DataConnectivityManagement

Updates a folder under a specified registry.

Specified by:

updateFolder in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRegistry

public UpdateRegistryResponse updateRegistry(UpdateRegistryRequest request)

Description copied from interface: DataConnectivityManagement

Updates the Data Connectivity Management Registry.

Specified by:

updateRegistry in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

validateDataAssetNetworkReachablity

public ValidateDataAssetNetworkReachablityResponse validateDataAssetNetworkReachablity(ValidateDataAssetNetworkReachablityRequest request)

Description copied from interface: DataConnectivityManagement

Validates the dataAsset network reachability.

Specified by:

validateDataAssetNetworkReachablity in interface DataConnectivityManagement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DataConnectivityManagementWaiters getWaiters()

Description copied from interface: DataConnectivityManagement

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DataConnectivityManagement

Returns:

The service waiters.

getPaginators

public DataConnectivityManagementPaginators getPaginators()

Description copied from interface: DataConnectivityManagement

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 interface DataConnectivityManagement

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable