@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public interface DataCatalogAsync extends AutoCloseable
Use the Data Catalog APIs to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata. For more information, see Data Catalog.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<AddCatalogLockResponse> addCatalogLock(AddCatalogLockRequest request, AsyncHandler<AddCatalogLockRequest,AddCatalogLockResponse> handler)
Adds a lock to a Catalog resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AddCatalogPrivateEndpointLockResponse> addCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest request, AsyncHandler<AddCatalogPrivateEndpointLockRequest,AddCatalogPrivateEndpointLockResponse> handler)
Adds a lock to a CatalogPrivateEndpoint resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AddDataSelectorPatternsResponse> addDataSelectorPatterns(AddDataSelectorPatternsRequest request, AsyncHandler<AddDataSelectorPatternsRequest,AddDataSelectorPatternsResponse> handler)
Add data selector pattern to the data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AddMetastoreLockResponse> addMetastoreLock(AddMetastoreLockRequest request, AsyncHandler<AddMetastoreLockRequest,AddMetastoreLockResponse> handler)
Adds a lock to a Metastore resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AssociateCustomPropertyResponse> associateCustomProperty(AssociateCustomPropertyRequest request, AsyncHandler<AssociateCustomPropertyRequest,AssociateCustomPropertyResponse> handler)
Associate the custom property for the given type
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AsynchronousExportDataAssetResponse> asynchronousExportDataAsset(AsynchronousExportDataAssetRequest request, AsyncHandler<AsynchronousExportDataAssetRequest,AsynchronousExportDataAssetResponse> handler)
Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AsynchronousExportGlossaryResponse> asynchronousExportGlossary(AsynchronousExportGlossaryRequest request, AsyncHandler<AsynchronousExportGlossaryRequest,AsynchronousExportGlossaryResponse> handler)
Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<AttachCatalogPrivateEndpointResponse> attachCatalogPrivateEndpoint(AttachCatalogPrivateEndpointRequest request, AsyncHandler<AttachCatalogPrivateEndpointRequest,AttachCatalogPrivateEndpointResponse> handler)
Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeCatalogCompartmentResponse> changeCatalogCompartment(ChangeCatalogCompartmentRequest request, AsyncHandler<ChangeCatalogCompartmentRequest,ChangeCatalogCompartmentResponse> handler)
Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeCatalogPrivateEndpointCompartmentResponse> changeCatalogPrivateEndpointCompartment(ChangeCatalogPrivateEndpointCompartmentRequest request, AsyncHandler<ChangeCatalogPrivateEndpointCompartmentRequest,ChangeCatalogPrivateEndpointCompartmentResponse> handler)
Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeMetastoreCompartmentResponse> changeMetastoreCompartment(ChangeMetastoreCompartmentRequest request, AsyncHandler<ChangeMetastoreCompartmentRequest,ChangeMetastoreCompartmentResponse> handler)
Moves a resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAttributeResponse> createAttribute(CreateAttributeRequest request, AsyncHandler<CreateAttributeRequest,CreateAttributeResponse> handler)
Creates a new entity attribute.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAttributeTagResponse> createAttributeTag(CreateAttributeTagRequest request, AsyncHandler<CreateAttributeTagRequest,CreateAttributeTagResponse> handler)
Creates a new entity attribute tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateCatalogResponse> createCatalog(CreateCatalogRequest request, AsyncHandler<CreateCatalogRequest,CreateCatalogResponse> handler)
Creates a new data catalog instance that includes a console and an API URL for managing metadata operations. For more information, please see the documentation.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateCatalogPrivateEndpointResponse> createCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest request, AsyncHandler<CreateCatalogPrivateEndpointRequest,CreateCatalogPrivateEndpointResponse> handler)
Create a new private reverse connection endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateConnectionResponse> createConnection(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResponse> handler)
Creates a new connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateCustomPropertyResponse> createCustomProperty(CreateCustomPropertyRequest request, AsyncHandler<CreateCustomPropertyRequest,CreateCustomPropertyResponse> handler)
Create a new Custom Property
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataAssetResponse> createDataAsset(CreateDataAssetRequest request, AsyncHandler<CreateDataAssetRequest,CreateDataAssetResponse> handler)
Create a new data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataAssetTagResponse> createDataAssetTag(CreateDataAssetTagRequest request, AsyncHandler<CreateDataAssetTagRequest,CreateDataAssetTagResponse> handler)
Creates a new data asset tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateEntityResponse> createEntity(CreateEntityRequest request, AsyncHandler<CreateEntityRequest,CreateEntityResponse> handler)
Creates a new data entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateEntityTagResponse> createEntityTag(CreateEntityTagRequest request, AsyncHandler<CreateEntityTagRequest,CreateEntityTagResponse> handler)
Creates a new entity tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateFolderResponse> createFolder(CreateFolderRequest request, AsyncHandler<CreateFolderRequest,CreateFolderResponse> handler)
Creates a new folder.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateFolderTagResponse> createFolderTag(CreateFolderTagRequest request, AsyncHandler<CreateFolderTagRequest,CreateFolderTagResponse> handler)
Creates a new folder tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateGlossaryResponse> createGlossary(CreateGlossaryRequest request, AsyncHandler<CreateGlossaryRequest,CreateGlossaryResponse> handler)
Creates a new glossary.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateJobResponse> createJob(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResponse> handler)
Creates a new job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateJobDefinitionResponse> createJobDefinition(CreateJobDefinitionRequest request, AsyncHandler<CreateJobDefinitionRequest,CreateJobDefinitionResponse> handler)
Creates a new job definition.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateJobExecutionResponse> createJobExecution(CreateJobExecutionRequest request, AsyncHandler<CreateJobExecutionRequest,CreateJobExecutionResponse> handler)
Creates a new job execution.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateMetastoreResponse> createMetastore(CreateMetastoreRequest request, AsyncHandler<CreateMetastoreRequest,CreateMetastoreResponse> handler)
Creates a new metastore.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateNamespaceResponse> createNamespace(CreateNamespaceRequest request, AsyncHandler<CreateNamespaceRequest,CreateNamespaceResponse> handler)
Create a new Namespace to be used by a custom property
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreatePatternResponse> createPattern(CreatePatternRequest request, AsyncHandler<CreatePatternRequest,CreatePatternResponse> handler)
Create a new pattern.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateTermResponse> createTerm(CreateTermRequest request, AsyncHandler<CreateTermRequest,CreateTermResponse> handler)
Create a new term within a glossary.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateTermRelationshipResponse> createTermRelationship(CreateTermRelationshipRequest request, AsyncHandler<CreateTermRelationshipRequest,CreateTermRelationshipResponse> handler)
Creates a new term relationship for this term within a glossary.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteAttributeResponse> deleteAttribute(DeleteAttributeRequest request, AsyncHandler<DeleteAttributeRequest,DeleteAttributeResponse> handler)
Deletes a specific entity attribute.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteAttributeTagResponse> deleteAttributeTag(DeleteAttributeTagRequest request, AsyncHandler<DeleteAttributeTagRequest,DeleteAttributeTagResponse> handler)
Deletes a specific entity attribute tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteCatalogResponse> deleteCatalog(DeleteCatalogRequest request, AsyncHandler<DeleteCatalogRequest,DeleteCatalogResponse> handler)
Deletes a data catalog resource by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteCatalogPrivateEndpointResponse> deleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest request, AsyncHandler<DeleteCatalogPrivateEndpointRequest,DeleteCatalogPrivateEndpointResponse> handler)
Deletes a private reverse connection endpoint by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteConnectionResponse> deleteConnection(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResponse> handler)
Deletes a specific connection of a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteCustomPropertyResponse> deleteCustomProperty(DeleteCustomPropertyRequest request, AsyncHandler<DeleteCustomPropertyRequest,DeleteCustomPropertyResponse> handler)
Deletes a specific custom property identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDataAssetResponse> deleteDataAsset(DeleteDataAssetRequest request, AsyncHandler<DeleteDataAssetRequest,DeleteDataAssetResponse> handler)
Deletes a specific data asset identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDataAssetTagResponse> deleteDataAssetTag(DeleteDataAssetTagRequest request, AsyncHandler<DeleteDataAssetTagRequest,DeleteDataAssetTagResponse> handler)
Deletes a specific data asset tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteEntityResponse> deleteEntity(DeleteEntityRequest request, AsyncHandler<DeleteEntityRequest,DeleteEntityResponse> handler)
Deletes a specific data entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteEntityTagResponse> deleteEntityTag(DeleteEntityTagRequest request, AsyncHandler<DeleteEntityTagRequest,DeleteEntityTagResponse> handler)
Deletes a specific entity tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteFolderResponse> deleteFolder(DeleteFolderRequest request, AsyncHandler<DeleteFolderRequest,DeleteFolderResponse> handler)
Deletes a specific folder of a data asset identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteFolderTagResponse> deleteFolderTag(DeleteFolderTagRequest request, AsyncHandler<DeleteFolderTagRequest,DeleteFolderTagResponse> handler)
Deletes a specific folder tag.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteGlossaryResponse> deleteGlossary(DeleteGlossaryRequest request, AsyncHandler<DeleteGlossaryRequest,DeleteGlossaryResponse> handler)
Deletes a specific glossary identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteJobResponse> deleteJob(DeleteJobRequest request, AsyncHandler<DeleteJobRequest,DeleteJobResponse> handler)
Deletes a specific job identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteJobDefinitionResponse> deleteJobDefinition(DeleteJobDefinitionRequest request, AsyncHandler<DeleteJobDefinitionRequest,DeleteJobDefinitionResponse> handler)
Deletes a specific job definition identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteMetastoreResponse> deleteMetastore(DeleteMetastoreRequest request, AsyncHandler<DeleteMetastoreRequest,DeleteMetastoreResponse> handler)
Deletes a metastore resource by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteNamespaceResponse> deleteNamespace(DeleteNamespaceRequest request, AsyncHandler<DeleteNamespaceRequest,DeleteNamespaceResponse> handler)
Deletes a specific Namespace identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeletePatternResponse> deletePattern(DeletePatternRequest request, AsyncHandler<DeletePatternRequest,DeletePatternResponse> handler)
Deletes a specific pattern identified by it’s key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteTermResponse> deleteTerm(DeleteTermRequest request, AsyncHandler<DeleteTermRequest,DeleteTermResponse> handler)
Deletes a specific glossary term.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteTermRelationshipResponse> deleteTermRelationship(DeleteTermRelationshipRequest request, AsyncHandler<DeleteTermRelationshipRequest,DeleteTermRelationshipResponse> handler)
Deletes a specific glossary term relationship.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DetachCatalogPrivateEndpointResponse> detachCatalogPrivateEndpoint(DetachCatalogPrivateEndpointRequest request, AsyncHandler<DetachCatalogPrivateEndpointRequest,DetachCatalogPrivateEndpointResponse> handler)
Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DisassociateCustomPropertyResponse> disassociateCustomProperty(DisassociateCustomPropertyRequest request, AsyncHandler<DisassociateCustomPropertyRequest,DisassociateCustomPropertyResponse> handler)
Remove the custom property for the given type
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ExpandTreeForGlossaryResponse> expandTreeForGlossary(ExpandTreeForGlossaryRequest request, AsyncHandler<ExpandTreeForGlossaryRequest,ExpandTreeForGlossaryResponse> handler)
Returns the fully expanded tree hierarchy of parent and child terms in this glossary.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ExportGlossaryResponse> exportGlossary(ExportGlossaryRequest request, AsyncHandler<ExportGlossaryRequest,ExportGlossaryResponse> handler)
Export the glossary and the terms and return the exported glossary as csv or json.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<FetchEntityLineageResponse> fetchEntityLineage(FetchEntityLineageRequest request, AsyncHandler<FetchEntityLineageRequest,FetchEntityLineageResponse> handler)
Returns lineage for a given entity object.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAttributeResponse> getAttribute(GetAttributeRequest request, AsyncHandler<GetAttributeRequest,GetAttributeResponse> handler)
Gets a specific entity attribute by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAttributeTagResponse> getAttributeTag(GetAttributeTagRequest request, AsyncHandler<GetAttributeTagRequest,GetAttributeTagResponse> handler)
Gets a specific entity attribute tag by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCatalogResponse> getCatalog(GetCatalogRequest request, AsyncHandler<GetCatalogRequest,GetCatalogResponse> handler)
Gets a data catalog by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCatalogPrivateEndpointResponse> getCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest request, AsyncHandler<GetCatalogPrivateEndpointRequest,GetCatalogPrivateEndpointResponse> handler)
Gets a specific private reverse connection by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetConnectionResponse> getConnection(GetConnectionRequest request, AsyncHandler<GetConnectionRequest,GetConnectionResponse> handler)
Gets a specific data asset connection by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetCustomPropertyResponse> getCustomProperty(GetCustomPropertyRequest request, AsyncHandler<GetCustomPropertyRequest,GetCustomPropertyResponse> handler)
Gets a specific custom property for the given key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataAssetResponse> getDataAsset(GetDataAssetRequest request, AsyncHandler<GetDataAssetRequest,GetDataAssetResponse> handler)
Gets a specific data asset for the given key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataAssetTagResponse> getDataAssetTag(GetDataAssetTagRequest request, AsyncHandler<GetDataAssetTagRequest,GetDataAssetTagResponse> handler)
Gets a specific data asset tag by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetEntityResponse> getEntity(GetEntityRequest request, AsyncHandler<GetEntityRequest,GetEntityResponse> handler)
Gets a specific data entity by key for a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetEntityTagResponse> getEntityTag(GetEntityTagRequest request, AsyncHandler<GetEntityTagRequest,GetEntityTagResponse> handler)
Gets a specific entity tag by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetFolderResponse> getFolder(GetFolderRequest request, AsyncHandler<GetFolderRequest,GetFolderResponse> handler)
Gets a specific data asset folder by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetFolderTagResponse> getFolderTag(GetFolderTagRequest request, AsyncHandler<GetFolderTagRequest,GetFolderTagResponse> handler)
Gets a specific folder tag by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetGlossaryResponse> getGlossary(GetGlossaryRequest request, AsyncHandler<GetGlossaryRequest,GetGlossaryResponse> handler)
Gets a specific glossary by key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobResponse> getJob(GetJobRequest request, AsyncHandler<GetJobRequest,GetJobResponse> handler)
Gets a specific job by key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobDefinitionResponse> getJobDefinition(GetJobDefinitionRequest request, AsyncHandler<GetJobDefinitionRequest,GetJobDefinitionResponse> handler)
Gets a specific job definition by key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobExecutionResponse> getJobExecution(GetJobExecutionRequest request, AsyncHandler<GetJobExecutionRequest,GetJobExecutionResponse> handler)
Gets a specific job execution by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobLogResponse> getJobLog(GetJobLogRequest request, AsyncHandler<GetJobLogRequest,GetJobLogResponse> handler)
Gets a specific job log by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetJobMetricsResponse> getJobMetrics(GetJobMetricsRequest request, AsyncHandler<GetJobMetricsRequest,GetJobMetricsResponse> handler)
Gets a specific job metric by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetMetastoreResponse> getMetastore(GetMetastoreRequest request, AsyncHandler<GetMetastoreRequest,GetMetastoreResponse> handler)
Gets a metastore by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetNamespaceResponse> getNamespace(GetNamespaceRequest request, AsyncHandler<GetNamespaceRequest,GetNamespaceResponse> handler)
Gets a specific namespace for the given key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetPatternResponse> getPattern(GetPatternRequest request, AsyncHandler<GetPatternRequest,GetPatternResponse> handler)
Gets a specific pattern for the given key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTermResponse> getTerm(GetTermRequest request, AsyncHandler<GetTermRequest,GetTermResponse> handler)
Gets a specific glossary term by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTermRelationshipResponse> getTermRelationship(GetTermRelationshipRequest request, AsyncHandler<GetTermRelationshipRequest,GetTermRelationshipResponse> handler)
Gets a specific glossary term relationship by key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTypeResponse> getType(GetTypeRequest request, AsyncHandler<GetTypeRequest,GetTypeResponse> handler)
Gets a specific type by key within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the work request with the given OCID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ImportConnectionResponse> importConnection(ImportConnectionRequest request, AsyncHandler<ImportConnectionRequest,ImportConnectionResponse> handler)
Import new connection for this data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ImportDataAssetResponse> importDataAsset(ImportDataAssetRequest request, AsyncHandler<ImportDataAssetRequest,ImportDataAssetResponse> handler)
Import technical objects to a Data Asset
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ImportGlossaryResponse> importGlossary(ImportGlossaryRequest request, AsyncHandler<ImportGlossaryRequest,ImportGlossaryResponse> handler)
Import the glossary and the terms from csv or json files and return the imported glossary resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ImportLineageResponse> importLineage(ImportLineageRequest request, AsyncHandler<ImportLineageRequest,ImportLineageResponse> handler)
Imports lineage metadata. Returns details about the job that performs the import.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAggregatedPhysicalEntitiesResponse> listAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest request, AsyncHandler<ListAggregatedPhysicalEntitiesRequest,ListAggregatedPhysicalEntitiesResponse> handler)
List the physical entities aggregated by this logical entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAttributeTagsResponse> listAttributeTags(ListAttributeTagsRequest request, AsyncHandler<ListAttributeTagsRequest,ListAttributeTagsResponse> handler)
Returns a list of all tags for an entity attribute.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAttributesResponse> listAttributes(ListAttributesRequest request, AsyncHandler<ListAttributesRequest,ListAttributesResponse> handler)
Returns a list of all attributes of an data entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCatalogPrivateEndpointsResponse> listCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest request, AsyncHandler<ListCatalogPrivateEndpointsRequest,ListCatalogPrivateEndpointsResponse> handler)
Returns a list of all the catalog private endpoints in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCatalogsResponse> listCatalogs(ListCatalogsRequest request, AsyncHandler<ListCatalogsRequest,ListCatalogsResponse> handler)
Returns a list of all the data catalogs in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListConnectionsResponse> listConnections(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResponse> handler)
Returns a list of all Connections for a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListCustomPropertiesResponse> listCustomProperties(ListCustomPropertiesRequest request, AsyncHandler<ListCustomPropertiesRequest,ListCustomPropertiesResponse> handler)
Returns a list of custom properties within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataAssetTagsResponse> listDataAssetTags(ListDataAssetTagsRequest request, AsyncHandler<ListDataAssetTagsRequest,ListDataAssetTagsResponse> handler)
Returns a list of all tags for a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataAssetsResponse> listDataAssets(ListDataAssetsRequest request, AsyncHandler<ListDataAssetsRequest,ListDataAssetsResponse> handler)
Returns a list of data assets within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDerivedLogicalEntitiesResponse> listDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest request, AsyncHandler<ListDerivedLogicalEntitiesRequest,ListDerivedLogicalEntitiesResponse> handler)
List logical entities derived from this pattern.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListEntitiesResponse> listEntities(ListEntitiesRequest request, AsyncHandler<ListEntitiesRequest,ListEntitiesResponse> handler)
Returns a list of all entities of a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListEntityTagsResponse> listEntityTags(ListEntityTagsRequest request, AsyncHandler<ListEntityTagsRequest,ListEntityTagsResponse> handler)
Returns a list of all tags for a data entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListFolderTagsResponse> listFolderTags(ListFolderTagsRequest request, AsyncHandler<ListFolderTagsRequest,ListFolderTagsResponse> handler)
Returns a list of all tags for a folder.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListFoldersResponse> listFolders(ListFoldersRequest request, AsyncHandler<ListFoldersRequest,ListFoldersResponse> handler)
Returns a list of all folders.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListGlossariesResponse> listGlossaries(ListGlossariesRequest request, AsyncHandler<ListGlossariesRequest,ListGlossariesResponse> handler)
Returns a list of all glossaries within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobDefinitionsResponse> listJobDefinitions(ListJobDefinitionsRequest request, AsyncHandler<ListJobDefinitionsRequest,ListJobDefinitionsResponse> handler)
Returns a list of job definitions within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobExecutionsResponse> listJobExecutions(ListJobExecutionsRequest request, AsyncHandler<ListJobExecutionsRequest,ListJobExecutionsResponse> handler)
Returns a list of job executions for a job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobLogsResponse> listJobLogs(ListJobLogsRequest request, AsyncHandler<ListJobLogsRequest,ListJobLogsResponse> handler)
Returns a list of job logs.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobMetricsResponse> listJobMetrics(ListJobMetricsRequest request, AsyncHandler<ListJobMetricsRequest,ListJobMetricsResponse> handler)
Returns a list of job metrics.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListJobsResponse> listJobs(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResponse> handler)
Returns a list of jobs within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListMetastoresResponse> listMetastores(ListMetastoresRequest request, AsyncHandler<ListMetastoresRequest,ListMetastoresResponse> handler)
Returns a list of all metastores in the specified compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListNamespacesResponse> listNamespaces(ListNamespacesRequest request, AsyncHandler<ListNamespacesRequest,ListNamespacesResponse> handler)
Returns a list of namespaces within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListPatternsResponse> listPatterns(ListPatternsRequest request, AsyncHandler<ListPatternsRequest,ListPatternsResponse> handler)
Returns a list of patterns within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListRulesResponse> listRules(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResponse> handler)
Returns a list of all rules of a data entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTagsResponse> listTags(ListTagsRequest request, AsyncHandler<ListTagsRequest,ListTagsResponse> handler)
Returns a list of all user created tags in the system.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTermRelationshipsResponse> listTermRelationships(ListTermRelationshipsRequest request, AsyncHandler<ListTermRelationshipsRequest,ListTermRelationshipsResponse> handler)
Returns a list of all term relationships within a glossary.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTermsResponse> listTerms(ListTermsRequest request, AsyncHandler<ListTermsRequest,ListTermsResponse> handler)
Returns a list of all terms within a glossary.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTypesResponse> listTypes(ListTypesRequest request, AsyncHandler<ListTypesRequest,ListTypesResponse> handler)
Returns a list of all types within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Returns a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ObjectStatsResponse> objectStats(ObjectStatsRequest request, AsyncHandler<ObjectStatsRequest,ObjectStatsResponse> handler)
Returns stats on objects by type in the repository.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ParseConnectionResponse> parseConnection(ParseConnectionRequest request, AsyncHandler<ParseConnectionRequest,ParseConnectionResponse> handler)
Parse data asset references through connections from this data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ProcessRecommendationResponse> processRecommendation(ProcessRecommendationRequest request, AsyncHandler<ProcessRecommendationRequest,ProcessRecommendationResponse> handler)
Act on a recommendation. A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RecommendationsResponse> recommendations(RecommendationsRequest request, AsyncHandler<RecommendationsRequest,RecommendationsResponse> handler)
Returns a list of recommendations for the given object and recommendation type. By default, it will return inferred recommendations for review. The optional query param ‘RecommendationStatus’ can be set, to return only recommendations having that status.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemoveCatalogLockResponse> removeCatalogLock(RemoveCatalogLockRequest request, AsyncHandler<RemoveCatalogLockRequest,RemoveCatalogLockResponse> handler)
Removes a lock from a Catalog resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemoveCatalogPrivateEndpointLockResponse> removeCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest request, AsyncHandler<RemoveCatalogPrivateEndpointLockRequest,RemoveCatalogPrivateEndpointLockResponse> handler)
Removes a lock from a CatalogPrivateEndpoint resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemoveDataSelectorPatternsResponse> removeDataSelectorPatterns(RemoveDataSelectorPatternsRequest request, AsyncHandler<RemoveDataSelectorPatternsRequest,RemoveDataSelectorPatternsResponse> handler)
Remove data selector pattern from the data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<RemoveMetastoreLockResponse> removeMetastoreLock(RemoveMetastoreLockRequest request, AsyncHandler<RemoveMetastoreLockRequest,RemoveMetastoreLockResponse> handler)
Removes a lock from a Metastore resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<SearchCriteriaResponse> searchCriteria(SearchCriteriaRequest request, AsyncHandler<SearchCriteriaRequest,SearchCriteriaResponse> handler)
Returns a list of search results within a data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<SuggestMatchesResponse> suggestMatches(SuggestMatchesRequest request, AsyncHandler<SuggestMatchesRequest,SuggestMatchesResponse> handler)
Returns a list of potential string matches for a given input string.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<SynchronousExportDataAssetResponse> synchronousExportDataAsset(SynchronousExportDataAssetRequest request, AsyncHandler<SynchronousExportDataAssetRequest,SynchronousExportDataAssetResponse> handler)
Export technical objects from a Data Asset
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<TestConnectionResponse> testConnection(TestConnectionRequest request, AsyncHandler<TestConnectionRequest,TestConnectionResponse> handler)
Test the connection by connecting to the data asset using credentials in the metadata.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateAttributeResponse> updateAttribute(UpdateAttributeRequest request, AsyncHandler<UpdateAttributeRequest,UpdateAttributeResponse> handler)
Updates a specific data asset attribute.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCatalogResponse> updateCatalog(UpdateCatalogRequest request, AsyncHandler<UpdateCatalogRequest,UpdateCatalogResponse> handler)
Updates the data catalog.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCatalogPrivateEndpointResponse> updateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest request, AsyncHandler<UpdateCatalogPrivateEndpointRequest,UpdateCatalogPrivateEndpointResponse> handler)
Updates the private reverse connection endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateConnectionResponse> updateConnection(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResponse> handler)
Updates a specific connection of a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateCustomPropertyResponse> updateCustomProperty(UpdateCustomPropertyRequest request, AsyncHandler<UpdateCustomPropertyRequest,UpdateCustomPropertyResponse> handler)
Updates a specific custom property identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDataAssetResponse> updateDataAsset(UpdateDataAssetRequest request, AsyncHandler<UpdateDataAssetRequest,UpdateDataAssetResponse> handler)
Updates a specific data asset identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateEntityResponse> updateEntity(UpdateEntityRequest request, AsyncHandler<UpdateEntityRequest,UpdateEntityResponse> handler)
Updates a specific data entity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateFolderResponse> updateFolder(UpdateFolderRequest request, AsyncHandler<UpdateFolderRequest,UpdateFolderResponse> handler)
Updates a specific folder of a data asset.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateGlossaryResponse> updateGlossary(UpdateGlossaryRequest request, AsyncHandler<UpdateGlossaryRequest,UpdateGlossaryResponse> handler)
Updates a specific glossary identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateJobResponse> updateJob(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResponse> handler)
Updates a specific job identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateJobDefinitionResponse> updateJobDefinition(UpdateJobDefinitionRequest request, AsyncHandler<UpdateJobDefinitionRequest,UpdateJobDefinitionResponse> handler)
Update a specific job definition identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateMetastoreResponse> updateMetastore(UpdateMetastoreRequest request, AsyncHandler<UpdateMetastoreRequest,UpdateMetastoreResponse> handler)
Updates a metastore resource by identifier.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateNamespaceResponse> updateNamespace(UpdateNamespaceRequest request, AsyncHandler<UpdateNamespaceRequest,UpdateNamespaceResponse> handler)
Updates a specific namespace identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdatePatternResponse> updatePattern(UpdatePatternRequest request, AsyncHandler<UpdatePatternRequest,UpdatePatternResponse> handler)
Updates a specific pattern identified by the given key.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateTermResponse> updateTerm(UpdateTermRequest request, AsyncHandler<UpdateTermRequest,UpdateTermResponse> handler)
Updates a specific glossary term.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateTermRelationshipResponse> updateTermRelationship(UpdateTermRelationshipRequest request, AsyncHandler<UpdateTermRelationshipRequest,UpdateTermRelationshipResponse> handler)
Updates a specific glossary term relationship.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UploadCredentialsResponse> uploadCredentials(UploadCredentialsRequest request, AsyncHandler<UploadCredentialsRequest,UploadCredentialsResponse> handler)
Upload connection credentails and metadata for this connection.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UsersResponse> users(UsersRequest request, AsyncHandler<UsersRequest,UsersResponse> handler)
Returns active users in the system.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ValidateConnectionResponse> validateConnection(ValidateConnectionRequest request, AsyncHandler<ValidateConnectionRequest,ValidateConnectionResponse> handler)
Validate connection by connecting to the data asset using credentials in metadata.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ValidatePatternResponse> validatePattern(ValidatePatternRequest request, AsyncHandler<ValidatePatternRequest,ValidatePatternResponse> handler)
Validate pattern by deriving file groups representing logical entities using the expression
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.