Class DataCatalogClient
- java.lang.Object
- 
- com.oracle.bmc.http.internal.BaseSyncClient
- 
- com.oracle.bmc.datacatalog.DataCatalogClient
 
 
- 
- All Implemented Interfaces:
- DataCatalog,- AutoCloseable
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public class DataCatalogClient extends BaseSyncClient implements DataCatalog
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classDataCatalogClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for DataCatalog.
 - 
Constructor SummaryConstructors Constructor Description DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddCatalogLockResponseaddCatalogLock(AddCatalogLockRequest request)Adds a lock to a Catalog resource.AddCatalogPrivateEndpointLockResponseaddCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest request)Adds a lock to a CatalogPrivateEndpoint resource.AddDataSelectorPatternsResponseaddDataSelectorPatterns(AddDataSelectorPatternsRequest request)Add data selector pattern to the data asset.AddMetastoreLockResponseaddMetastoreLock(AddMetastoreLockRequest request)Adds a lock to a Metastore resource.AssociateCustomPropertyResponseassociateCustomProperty(AssociateCustomPropertyRequest request)Associate the custom property for the given typeAsynchronousExportDataAssetResponseasynchronousExportDataAsset(AsynchronousExportDataAssetRequest request)Export technical objects from a Data Asset in Excel format.AsynchronousExportGlossaryResponseasynchronousExportGlossary(AsynchronousExportGlossaryRequest request)Exports the contents of a glossary in Excel format.AttachCatalogPrivateEndpointResponseattachCatalogPrivateEndpoint(AttachCatalogPrivateEndpointRequest request)Attaches a private reverse connection endpoint resource to a data catalog resource.static DataCatalogClient.Builderbuilder()Create a builder for this client.ChangeCatalogCompartmentResponsechangeCatalogCompartment(ChangeCatalogCompartmentRequest request)Moves a resource into a different compartment.ChangeCatalogPrivateEndpointCompartmentResponsechangeCatalogPrivateEndpointCompartment(ChangeCatalogPrivateEndpointCompartmentRequest request)Moves a resource into a different compartment.ChangeMetastoreCompartmentResponsechangeMetastoreCompartment(ChangeMetastoreCompartmentRequest request)Moves a resource into a different compartment.voidclose()CreateAttributeResponsecreateAttribute(CreateAttributeRequest request)Creates a new entity attribute.CreateAttributeTagResponsecreateAttributeTag(CreateAttributeTagRequest request)Creates a new entity attribute tag.CreateCatalogResponsecreateCatalog(CreateCatalogRequest request)Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.CreateCatalogPrivateEndpointResponsecreateCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest request)Create a new private reverse connection endpoint.CreateConnectionResponsecreateConnection(CreateConnectionRequest request)Creates a new connection.CreateCustomPropertyResponsecreateCustomProperty(CreateCustomPropertyRequest request)Create a new Custom PropertyCreateDataAssetResponsecreateDataAsset(CreateDataAssetRequest request)Create a new data asset.CreateDataAssetTagResponsecreateDataAssetTag(CreateDataAssetTagRequest request)Creates a new data asset tag.CreateEntityResponsecreateEntity(CreateEntityRequest request)Creates a new data entity.CreateEntityTagResponsecreateEntityTag(CreateEntityTagRequest request)Creates a new entity tag.CreateFolderResponsecreateFolder(CreateFolderRequest request)Creates a new folder.CreateFolderTagResponsecreateFolderTag(CreateFolderTagRequest request)Creates a new folder tag.CreateGlossaryResponsecreateGlossary(CreateGlossaryRequest request)Creates a new glossary.CreateJobResponsecreateJob(CreateJobRequest request)Creates a new job.CreateJobDefinitionResponsecreateJobDefinition(CreateJobDefinitionRequest request)Creates a new job definition.CreateJobExecutionResponsecreateJobExecution(CreateJobExecutionRequest request)Creates a new job execution.CreateMetastoreResponsecreateMetastore(CreateMetastoreRequest request)Creates a new metastore.CreateNamespaceResponsecreateNamespace(CreateNamespaceRequest request)Create a new Namespace to be used by a custom propertyCreatePatternResponsecreatePattern(CreatePatternRequest request)Create a new pattern.CreateTermResponsecreateTerm(CreateTermRequest request)Create a new term within a glossary.CreateTermRelationshipResponsecreateTermRelationship(CreateTermRelationshipRequest request)Creates a new term relationship for this term within a glossary.DeleteAttributeResponsedeleteAttribute(DeleteAttributeRequest request)Deletes a specific entity attribute.DeleteAttributeTagResponsedeleteAttributeTag(DeleteAttributeTagRequest request)Deletes a specific entity attribute tag.DeleteCatalogResponsedeleteCatalog(DeleteCatalogRequest request)Deletes a data catalog resource by identifier.DeleteCatalogPrivateEndpointResponsedeleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest request)Deletes a private reverse connection endpoint by identifier.DeleteConnectionResponsedeleteConnection(DeleteConnectionRequest request)Deletes a specific connection of a data asset.DeleteCustomPropertyResponsedeleteCustomProperty(DeleteCustomPropertyRequest request)Deletes a specific custom property identified by it’s key.DeleteDataAssetResponsedeleteDataAsset(DeleteDataAssetRequest request)Deletes a specific data asset identified by it’s key.DeleteDataAssetTagResponsedeleteDataAssetTag(DeleteDataAssetTagRequest request)Deletes a specific data asset tag.DeleteEntityResponsedeleteEntity(DeleteEntityRequest request)Deletes a specific data entity.DeleteEntityTagResponsedeleteEntityTag(DeleteEntityTagRequest request)Deletes a specific entity tag.DeleteFolderResponsedeleteFolder(DeleteFolderRequest request)Deletes a specific folder of a data asset identified by it’s key.DeleteFolderTagResponsedeleteFolderTag(DeleteFolderTagRequest request)Deletes a specific folder tag.DeleteGlossaryResponsedeleteGlossary(DeleteGlossaryRequest request)Deletes a specific glossary identified by it’s key.DeleteJobResponsedeleteJob(DeleteJobRequest request)Deletes a specific job identified by it’s key.DeleteJobDefinitionResponsedeleteJobDefinition(DeleteJobDefinitionRequest request)Deletes a specific job definition identified by it’s key.DeleteMetastoreResponsedeleteMetastore(DeleteMetastoreRequest request)Deletes a metastore resource by identifier.DeleteNamespaceResponsedeleteNamespace(DeleteNamespaceRequest request)Deletes a specific Namespace identified by it’s key.DeletePatternResponsedeletePattern(DeletePatternRequest request)Deletes a specific pattern identified by it’s key.DeleteTermResponsedeleteTerm(DeleteTermRequest request)Deletes a specific glossary term.DeleteTermRelationshipResponsedeleteTermRelationship(DeleteTermRelationshipRequest request)Deletes a specific glossary term relationship.DetachCatalogPrivateEndpointResponsedetachCatalogPrivateEndpoint(DetachCatalogPrivateEndpointRequest request)Detaches a private reverse connection endpoint resource to a data catalog resource.DisassociateCustomPropertyResponsedisassociateCustomProperty(DisassociateCustomPropertyRequest request)Remove the custom property for the given typeExpandTreeForGlossaryResponseexpandTreeForGlossary(ExpandTreeForGlossaryRequest request)Returns the fully expanded tree hierarchy of parent and child terms in this glossary.ExportGlossaryResponseexportGlossary(ExportGlossaryRequest request)Export the glossary and the terms and return the exported glossary as csv or json.FetchEntityLineageResponsefetchEntityLineage(FetchEntityLineageRequest request)Returns lineage for a given entity object.GetAttributeResponsegetAttribute(GetAttributeRequest request)Gets a specific entity attribute by key.GetAttributeTagResponsegetAttributeTag(GetAttributeTagRequest request)Gets a specific entity attribute tag by key.GetCatalogResponsegetCatalog(GetCatalogRequest request)Gets a data catalog by identifier.GetCatalogPrivateEndpointResponsegetCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest request)Gets a specific private reverse connection by identifier.StringgetClientCommonLibraryVersion()GetConnectionResponsegetConnection(GetConnectionRequest request)Gets a specific data asset connection by key.GetCustomPropertyResponsegetCustomProperty(GetCustomPropertyRequest request)Gets a specific custom property for the given key within a data catalog.GetDataAssetResponsegetDataAsset(GetDataAssetRequest request)Gets a specific data asset for the given key within a data catalog.GetDataAssetTagResponsegetDataAssetTag(GetDataAssetTagRequest request)Gets a specific data asset tag by key.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()GetEntityResponsegetEntity(GetEntityRequest request)Gets a specific data entity by key for a data asset.GetEntityTagResponsegetEntityTag(GetEntityTagRequest request)Gets a specific entity tag by key.GetFolderResponsegetFolder(GetFolderRequest request)Gets a specific data asset folder by key.GetFolderTagResponsegetFolderTag(GetFolderTagRequest request)Gets a specific folder tag by key.GetGlossaryResponsegetGlossary(GetGlossaryRequest request)Gets a specific glossary by key within a data catalog.GetJobResponsegetJob(GetJobRequest request)Gets a specific job by key within a data catalog.GetJobDefinitionResponsegetJobDefinition(GetJobDefinitionRequest request)Gets a specific job definition by key within a data catalog.GetJobExecutionResponsegetJobExecution(GetJobExecutionRequest request)Gets a specific job execution by key.GetJobLogResponsegetJobLog(GetJobLogRequest request)Gets a specific job log by key.GetJobMetricsResponsegetJobMetrics(GetJobMetricsRequest request)Gets a specific job metric by key.GetMetastoreResponsegetMetastore(GetMetastoreRequest request)Gets a metastore by identifier.Optional<String>getMinimumClientCommonLibraryVersionFromClient()GetNamespaceResponsegetNamespace(GetNamespaceRequest request)Gets a specific namespace for the given key within a data catalog.DataCatalogPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPatternResponsegetPattern(GetPatternRequest request)Gets a specific pattern for the given key within a data catalog.GetTermResponsegetTerm(GetTermRequest request)Gets a specific glossary term by key.GetTermRelationshipResponsegetTermRelationship(GetTermRelationshipRequest request)Gets a specific glossary term relationship by key.GetTypeResponsegetType(GetTypeRequest request)Gets a specific type by key within a data catalog.DataCatalogWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the status of the work request with the given OCID.ImportConnectionResponseimportConnection(ImportConnectionRequest request)Import new connection for this data asset.ImportDataAssetResponseimportDataAsset(ImportDataAssetRequest request)Import technical objects to a Data AssetImportGlossaryResponseimportGlossary(ImportGlossaryRequest request)Import the glossary and the terms from csv or json files and return the imported glossary resource.ImportLineageResponseimportLineage(ImportLineageRequest request)Imports lineage metadata.ListAggregatedPhysicalEntitiesResponselistAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest request)List the physical entities aggregated by this logical entity.ListAttributesResponselistAttributes(ListAttributesRequest request)Returns a list of all attributes of an data entity.ListAttributeTagsResponselistAttributeTags(ListAttributeTagsRequest request)Returns a list of all tags for an entity attribute.ListCatalogPrivateEndpointsResponselistCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest request)Returns a list of all the catalog private endpoints in the specified compartment.ListCatalogsResponselistCatalogs(ListCatalogsRequest request)Returns a list of all the data catalogs in the specified compartment.ListConnectionsResponselistConnections(ListConnectionsRequest request)Returns a list of all Connections for a data asset.ListCustomPropertiesResponselistCustomProperties(ListCustomPropertiesRequest request)Returns a list of custom properties within a data catalog.ListDataAssetsResponselistDataAssets(ListDataAssetsRequest request)Returns a list of data assets within a data catalog.ListDataAssetTagsResponselistDataAssetTags(ListDataAssetTagsRequest request)Returns a list of all tags for a data asset.ListDerivedLogicalEntitiesResponselistDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest request)List logical entities derived from this pattern.ListEntitiesResponselistEntities(ListEntitiesRequest request)Returns a list of all entities of a data asset.ListEntityTagsResponselistEntityTags(ListEntityTagsRequest request)Returns a list of all tags for a data entity.ListFoldersResponselistFolders(ListFoldersRequest request)Returns a list of all folders.ListFolderTagsResponselistFolderTags(ListFolderTagsRequest request)Returns a list of all tags for a folder.ListGlossariesResponselistGlossaries(ListGlossariesRequest request)Returns a list of all glossaries within a data catalog.ListJobDefinitionsResponselistJobDefinitions(ListJobDefinitionsRequest request)Returns a list of job definitions within a data catalog.ListJobExecutionsResponselistJobExecutions(ListJobExecutionsRequest request)Returns a list of job executions for a job.ListJobLogsResponselistJobLogs(ListJobLogsRequest request)Returns a list of job logs.ListJobMetricsResponselistJobMetrics(ListJobMetricsRequest request)Returns a list of job metrics.ListJobsResponselistJobs(ListJobsRequest request)Returns a list of jobs within a data catalog.ListMetastoresResponselistMetastores(ListMetastoresRequest request)Returns a list of all metastores in the specified compartment.ListNamespacesResponselistNamespaces(ListNamespacesRequest request)Returns a list of namespaces within a data catalog.ListPatternsResponselistPatterns(ListPatternsRequest request)Returns a list of patterns within a data catalog.ListRulesResponselistRules(ListRulesRequest request)Returns a list of all rules of a data entity.ListTagsResponselistTags(ListTagsRequest request)Returns a list of all user created tags in the system.ListTermRelationshipsResponselistTermRelationships(ListTermRelationshipsRequest request)Returns a list of all term relationships within a glossary.ListTermsResponselistTerms(ListTermsRequest request)Returns a list of all terms within a glossary.ListTypesResponselistTypes(ListTypesRequest request)Returns a list of all types within a data catalog.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Returns a (paginated) list of errors for a given work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Returns a (paginated) list of logs for a given work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.ObjectStatsResponseobjectStats(ObjectStatsRequest request)Returns stats on objects by type in the repository.ParseConnectionResponseparseConnection(ParseConnectionRequest request)Parse data asset references through connections from this data asset.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.ProcessRecommendationResponseprocessRecommendation(ProcessRecommendationRequest request)Act on a recommendation.RecommendationsResponserecommendations(RecommendationsRequest request)Returns a list of recommendations for the given object and recommendation type.voidrefreshClient()Rebuild the backingHttpClient.RemoveCatalogLockResponseremoveCatalogLock(RemoveCatalogLockRequest request)Removes a lock from a Catalog resource.RemoveCatalogPrivateEndpointLockResponseremoveCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest request)Removes a lock from a CatalogPrivateEndpoint resource.RemoveDataSelectorPatternsResponseremoveDataSelectorPatterns(RemoveDataSelectorPatternsRequest request)Remove data selector pattern from the data asset.RemoveMetastoreLockResponseremoveMetastoreLock(RemoveMetastoreLockRequest request)Removes a lock from a Metastore resource.SearchCriteriaResponsesearchCriteria(SearchCriteriaRequest request)Returns a list of search results within a data catalog.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).SuggestMatchesResponsesuggestMatches(SuggestMatchesRequest request)Returns a list of potential string matches for a given input string.SynchronousExportDataAssetResponsesynchronousExportDataAsset(SynchronousExportDataAssetRequest request)Export technical objects from a Data AssetTestConnectionResponsetestConnection(TestConnectionRequest request)Test the connection by connecting to the data asset using credentials in the metadata.UpdateAttributeResponseupdateAttribute(UpdateAttributeRequest request)Updates a specific data asset attribute.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateCatalogResponseupdateCatalog(UpdateCatalogRequest request)Updates the data catalog.UpdateCatalogPrivateEndpointResponseupdateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest request)Updates the private reverse connection endpoint.UpdateConnectionResponseupdateConnection(UpdateConnectionRequest request)Updates a specific connection of a data asset.UpdateCustomPropertyResponseupdateCustomProperty(UpdateCustomPropertyRequest request)Updates a specific custom property identified by the given key.UpdateDataAssetResponseupdateDataAsset(UpdateDataAssetRequest request)Updates a specific data asset identified by the given key.UpdateEntityResponseupdateEntity(UpdateEntityRequest request)Updates a specific data entity.UpdateFolderResponseupdateFolder(UpdateFolderRequest request)Updates a specific folder of a data asset.UpdateGlossaryResponseupdateGlossary(UpdateGlossaryRequest request)Updates a specific glossary identified by the given key.UpdateJobResponseupdateJob(UpdateJobRequest request)Updates a specific job identified by the given key.UpdateJobDefinitionResponseupdateJobDefinition(UpdateJobDefinitionRequest request)Update a specific job definition identified by the given key.UpdateMetastoreResponseupdateMetastore(UpdateMetastoreRequest request)Updates a metastore resource by identifier.UpdateNamespaceResponseupdateNamespace(UpdateNamespaceRequest request)Updates a specific namespace identified by the given key.UpdatePatternResponseupdatePattern(UpdatePatternRequest request)Updates a specific pattern identified by the given key.UpdateTermResponseupdateTerm(UpdateTermRequest request)Updates a specific glossary term.UpdateTermRelationshipResponseupdateTermRelationship(UpdateTermRelationshipRequest request)Updates a specific glossary term relationship.UploadCredentialsResponseuploadCredentials(UploadCredentialsRequest request)Upload connection credentails and metadata for this connection.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.UsersResponseusers(UsersRequest request)Returns active users in the system.ValidateConnectionResponsevalidateConnection(ValidateConnectionRequest request)Validate connection by connecting to the data asset using credentials in metadata.ValidatePatternResponsevalidatePattern(ValidatePatternRequest request)Validate pattern by deriving file groups representing logical entities using the expression- 
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClientclientCall
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.datacatalog.DataCataloggetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
DataCatalogClient@Deprecated public DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
- clientConfigurator-- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
- defaultRequestSignerFactory-- ClientBuilderBase.requestSignerFactory
- additionalClientConfigurators-- ClientBuilderBase.additionalClientConfigurators
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.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)
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.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
 
 - 
DataCatalogClient@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- DataCatalogClient.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-- DataCatalogClient.Builder.executorService
 
 
- 
 - 
Method Detail- 
builderpublic static DataCatalogClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:DataCatalogSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
- setRegionin interface- DataCatalog
- Parameters:
- region- The region of the service.
 
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:DataCatalogSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format ( Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
- setRegionin interface- DataCatalog
- Parameters:
- regionId- The public region ID.
 
 - 
addCatalogLockpublic AddCatalogLockResponse addCatalogLock(AddCatalogLockRequest request) Description copied from interface:DataCatalogAdds a lock to a Catalog resource.- Specified by:
- addCatalogLockin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addCatalogPrivateEndpointLockpublic AddCatalogPrivateEndpointLockResponse addCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest request) Description copied from interface:DataCatalogAdds a lock to a CatalogPrivateEndpoint resource.- Specified by:
- addCatalogPrivateEndpointLockin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addDataSelectorPatternspublic AddDataSelectorPatternsResponse addDataSelectorPatterns(AddDataSelectorPatternsRequest request) Description copied from interface:DataCatalogAdd data selector pattern to the data asset.- Specified by:
- addDataSelectorPatternsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
addMetastoreLockpublic AddMetastoreLockResponse addMetastoreLock(AddMetastoreLockRequest request) Description copied from interface:DataCatalogAdds a lock to a Metastore resource.- Specified by:
- addMetastoreLockin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
associateCustomPropertypublic AssociateCustomPropertyResponse associateCustomProperty(AssociateCustomPropertyRequest request) Description copied from interface:DataCatalogAssociate the custom property for the given type- Specified by:
- associateCustomPropertyin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
asynchronousExportDataAssetpublic AsynchronousExportDataAssetResponse asynchronousExportDataAsset(AsynchronousExportDataAssetRequest request) Description copied from interface:DataCatalogExport technical objects from a Data Asset in Excel format.Returns details about the job which actually performs the export. - Specified by:
- asynchronousExportDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
asynchronousExportGlossarypublic AsynchronousExportGlossaryResponse asynchronousExportGlossary(AsynchronousExportGlossaryRequest request) Description copied from interface:DataCatalogExports the contents of a glossary in Excel format.Returns details about the job which actually performs the export. - Specified by:
- asynchronousExportGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
attachCatalogPrivateEndpointpublic AttachCatalogPrivateEndpointResponse attachCatalogPrivateEndpoint(AttachCatalogPrivateEndpointRequest request) Description copied from interface:DataCatalogAttaches a private reverse connection endpoint resource to a data catalog resource.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource. - Specified by:
- attachCatalogPrivateEndpointin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeCatalogCompartmentpublic ChangeCatalogCompartmentResponse changeCatalogCompartment(ChangeCatalogCompartmentRequest request) Description copied from interface:DataCatalogMoves a resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource. - Specified by:
- changeCatalogCompartmentin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeCatalogPrivateEndpointCompartmentpublic ChangeCatalogPrivateEndpointCompartmentResponse changeCatalogPrivateEndpointCompartment(ChangeCatalogPrivateEndpointCompartmentRequest request) Description copied from interface:DataCatalogMoves a resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource. - Specified by:
- changeCatalogPrivateEndpointCompartmentin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeMetastoreCompartmentpublic ChangeMetastoreCompartmentResponse changeMetastoreCompartment(ChangeMetastoreCompartmentRequest request) Description copied from interface:DataCatalogMoves a resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource. - Specified by:
- changeMetastoreCompartmentin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createAttributepublic CreateAttributeResponse createAttribute(CreateAttributeRequest request) Description copied from interface:DataCatalogCreates a new entity attribute.- Specified by:
- createAttributein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createAttributeTagpublic CreateAttributeTagResponse createAttributeTag(CreateAttributeTagRequest request) Description copied from interface:DataCatalogCreates a new entity attribute tag.- Specified by:
- createAttributeTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createCatalogpublic CreateCatalogResponse createCatalog(CreateCatalogRequest request) Description copied from interface:DataCatalogCreates a new data catalog instance that includes a console and an API URL for managing metadata operations.For more information, please see the documentation. - Specified by:
- createCatalogin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createCatalogPrivateEndpointpublic CreateCatalogPrivateEndpointResponse createCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest request) Description copied from interface:DataCatalogCreate a new private reverse connection endpoint.- Specified by:
- createCatalogPrivateEndpointin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createConnectionpublic CreateConnectionResponse createConnection(CreateConnectionRequest request) Description copied from interface:DataCatalogCreates a new connection.- Specified by:
- createConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createCustomPropertypublic CreateCustomPropertyResponse createCustomProperty(CreateCustomPropertyRequest request) Description copied from interface:DataCatalogCreate a new Custom Property- Specified by:
- createCustomPropertyin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createDataAssetpublic CreateDataAssetResponse createDataAsset(CreateDataAssetRequest request) Description copied from interface:DataCatalogCreate a new data asset.- Specified by:
- createDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createDataAssetTagpublic CreateDataAssetTagResponse createDataAssetTag(CreateDataAssetTagRequest request) Description copied from interface:DataCatalogCreates a new data asset tag.- Specified by:
- createDataAssetTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createEntitypublic CreateEntityResponse createEntity(CreateEntityRequest request) Description copied from interface:DataCatalogCreates a new data entity.- Specified by:
- createEntityin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createEntityTagpublic CreateEntityTagResponse createEntityTag(CreateEntityTagRequest request) Description copied from interface:DataCatalogCreates a new entity tag.- Specified by:
- createEntityTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createFolderpublic CreateFolderResponse createFolder(CreateFolderRequest request) Description copied from interface:DataCatalogCreates a new folder.- Specified by:
- createFolderin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createFolderTagpublic CreateFolderTagResponse createFolderTag(CreateFolderTagRequest request) Description copied from interface:DataCatalogCreates a new folder tag.- Specified by:
- createFolderTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createGlossarypublic CreateGlossaryResponse createGlossary(CreateGlossaryRequest request) Description copied from interface:DataCatalogCreates a new glossary.- Specified by:
- createGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createJobpublic CreateJobResponse createJob(CreateJobRequest request) Description copied from interface:DataCatalogCreates a new job.- Specified by:
- createJobin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createJobDefinitionpublic CreateJobDefinitionResponse createJobDefinition(CreateJobDefinitionRequest request) Description copied from interface:DataCatalogCreates a new job definition.- Specified by:
- createJobDefinitionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createJobExecutionpublic CreateJobExecutionResponse createJobExecution(CreateJobExecutionRequest request) Description copied from interface:DataCatalogCreates a new job execution.- Specified by:
- createJobExecutionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createMetastorepublic CreateMetastoreResponse createMetastore(CreateMetastoreRequest request) Description copied from interface:DataCatalogCreates a new metastore.- Specified by:
- createMetastorein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createNamespacepublic CreateNamespaceResponse createNamespace(CreateNamespaceRequest request) Description copied from interface:DataCatalogCreate a new Namespace to be used by a custom property- Specified by:
- createNamespacein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createPatternpublic CreatePatternResponse createPattern(CreatePatternRequest request) Description copied from interface:DataCatalogCreate a new pattern.- Specified by:
- createPatternin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createTermpublic CreateTermResponse createTerm(CreateTermRequest request) Description copied from interface:DataCatalogCreate a new term within a glossary.- Specified by:
- createTermin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createTermRelationshippublic CreateTermRelationshipResponse createTermRelationship(CreateTermRelationshipRequest request) Description copied from interface:DataCatalogCreates a new term relationship for this term within a glossary.- Specified by:
- createTermRelationshipin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteAttributepublic DeleteAttributeResponse deleteAttribute(DeleteAttributeRequest request) Description copied from interface:DataCatalogDeletes a specific entity attribute.- Specified by:
- deleteAttributein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteAttributeTagpublic DeleteAttributeTagResponse deleteAttributeTag(DeleteAttributeTagRequest request) Description copied from interface:DataCatalogDeletes a specific entity attribute tag.- Specified by:
- deleteAttributeTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteCatalogpublic DeleteCatalogResponse deleteCatalog(DeleteCatalogRequest request) Description copied from interface:DataCatalogDeletes a data catalog resource by identifier.- Specified by:
- deleteCatalogin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteCatalogPrivateEndpointpublic DeleteCatalogPrivateEndpointResponse deleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest request) Description copied from interface:DataCatalogDeletes a private reverse connection endpoint by identifier.- Specified by:
- deleteCatalogPrivateEndpointin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteConnectionpublic DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request) Description copied from interface:DataCatalogDeletes a specific connection of a data asset.- Specified by:
- deleteConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteCustomPropertypublic DeleteCustomPropertyResponse deleteCustomProperty(DeleteCustomPropertyRequest request) Description copied from interface:DataCatalogDeletes a specific custom property identified by it’s key.- Specified by:
- deleteCustomPropertyin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteDataAssetpublic DeleteDataAssetResponse deleteDataAsset(DeleteDataAssetRequest request) Description copied from interface:DataCatalogDeletes a specific data asset identified by it’s key.- Specified by:
- deleteDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteDataAssetTagpublic DeleteDataAssetTagResponse deleteDataAssetTag(DeleteDataAssetTagRequest request) Description copied from interface:DataCatalogDeletes a specific data asset tag.- Specified by:
- deleteDataAssetTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteEntitypublic DeleteEntityResponse deleteEntity(DeleteEntityRequest request) Description copied from interface:DataCatalogDeletes a specific data entity.- Specified by:
- deleteEntityin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteEntityTagpublic DeleteEntityTagResponse deleteEntityTag(DeleteEntityTagRequest request) Description copied from interface:DataCatalogDeletes a specific entity tag.- Specified by:
- deleteEntityTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteFolderpublic DeleteFolderResponse deleteFolder(DeleteFolderRequest request) Description copied from interface:DataCatalogDeletes a specific folder of a data asset identified by it’s key.- Specified by:
- deleteFolderin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteFolderTagpublic DeleteFolderTagResponse deleteFolderTag(DeleteFolderTagRequest request) Description copied from interface:DataCatalogDeletes a specific folder tag.- Specified by:
- deleteFolderTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteGlossarypublic DeleteGlossaryResponse deleteGlossary(DeleteGlossaryRequest request) Description copied from interface:DataCatalogDeletes a specific glossary identified by it’s key.- Specified by:
- deleteGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteJobpublic DeleteJobResponse deleteJob(DeleteJobRequest request) Description copied from interface:DataCatalogDeletes a specific job identified by it’s key.- Specified by:
- deleteJobin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteJobDefinitionpublic DeleteJobDefinitionResponse deleteJobDefinition(DeleteJobDefinitionRequest request) Description copied from interface:DataCatalogDeletes a specific job definition identified by it’s key.- Specified by:
- deleteJobDefinitionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteMetastorepublic DeleteMetastoreResponse deleteMetastore(DeleteMetastoreRequest request) Description copied from interface:DataCatalogDeletes a metastore resource by identifier.- Specified by:
- deleteMetastorein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteNamespacepublic DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest request) Description copied from interface:DataCatalogDeletes a specific Namespace identified by it’s key.- Specified by:
- deleteNamespacein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deletePatternpublic DeletePatternResponse deletePattern(DeletePatternRequest request) Description copied from interface:DataCatalogDeletes a specific pattern identified by it’s key.- Specified by:
- deletePatternin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteTermpublic DeleteTermResponse deleteTerm(DeleteTermRequest request) Description copied from interface:DataCatalogDeletes a specific glossary term.- Specified by:
- deleteTermin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteTermRelationshippublic DeleteTermRelationshipResponse deleteTermRelationship(DeleteTermRelationshipRequest request) Description copied from interface:DataCatalogDeletes a specific glossary term relationship.- Specified by:
- deleteTermRelationshipin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
detachCatalogPrivateEndpointpublic DetachCatalogPrivateEndpointResponse detachCatalogPrivateEndpoint(DetachCatalogPrivateEndpointRequest request) Description copied from interface:DataCatalogDetaches a private reverse connection endpoint resource to a data catalog resource.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource. - Specified by:
- detachCatalogPrivateEndpointin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
disassociateCustomPropertypublic DisassociateCustomPropertyResponse disassociateCustomProperty(DisassociateCustomPropertyRequest request) Description copied from interface:DataCatalogRemove the custom property for the given type- Specified by:
- disassociateCustomPropertyin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
expandTreeForGlossarypublic ExpandTreeForGlossaryResponse expandTreeForGlossary(ExpandTreeForGlossaryRequest request) Description copied from interface:DataCatalogReturns the fully expanded tree hierarchy of parent and child terms in this glossary.- Specified by:
- expandTreeForGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
exportGlossarypublic ExportGlossaryResponse exportGlossary(ExportGlossaryRequest request) Description copied from interface:DataCatalogExport the glossary and the terms and return the exported glossary as csv or json.- Specified by:
- exportGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
fetchEntityLineagepublic FetchEntityLineageResponse fetchEntityLineage(FetchEntityLineageRequest request) Description copied from interface:DataCatalogReturns lineage for a given entity object.- Specified by:
- fetchEntityLineagein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getAttributepublic GetAttributeResponse getAttribute(GetAttributeRequest request) Description copied from interface:DataCatalogGets a specific entity attribute by key.- Specified by:
- getAttributein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getAttributeTagpublic GetAttributeTagResponse getAttributeTag(GetAttributeTagRequest request) Description copied from interface:DataCatalogGets a specific entity attribute tag by key.- Specified by:
- getAttributeTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getCatalogpublic GetCatalogResponse getCatalog(GetCatalogRequest request) Description copied from interface:DataCatalogGets a data catalog by identifier.- Specified by:
- getCatalogin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getCatalogPrivateEndpointpublic GetCatalogPrivateEndpointResponse getCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest request) Description copied from interface:DataCatalogGets a specific private reverse connection by identifier.- Specified by:
- getCatalogPrivateEndpointin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getConnectionpublic GetConnectionResponse getConnection(GetConnectionRequest request) Description copied from interface:DataCatalogGets a specific data asset connection by key.- Specified by:
- getConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getCustomPropertypublic GetCustomPropertyResponse getCustomProperty(GetCustomPropertyRequest request) Description copied from interface:DataCatalogGets a specific custom property for the given key within a data catalog.- Specified by:
- getCustomPropertyin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getDataAssetpublic GetDataAssetResponse getDataAsset(GetDataAssetRequest request) Description copied from interface:DataCatalogGets a specific data asset for the given key within a data catalog.- Specified by:
- getDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getDataAssetTagpublic GetDataAssetTagResponse getDataAssetTag(GetDataAssetTagRequest request) Description copied from interface:DataCatalogGets a specific data asset tag by key.- Specified by:
- getDataAssetTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getEntitypublic GetEntityResponse getEntity(GetEntityRequest request) Description copied from interface:DataCatalogGets a specific data entity by key for a data asset.- Specified by:
- getEntityin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getEntityTagpublic GetEntityTagResponse getEntityTag(GetEntityTagRequest request) Description copied from interface:DataCatalogGets a specific entity tag by key.- Specified by:
- getEntityTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getFolderpublic GetFolderResponse getFolder(GetFolderRequest request) Description copied from interface:DataCatalogGets a specific data asset folder by key.- Specified by:
- getFolderin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getFolderTagpublic GetFolderTagResponse getFolderTag(GetFolderTagRequest request) Description copied from interface:DataCatalogGets a specific folder tag by key.- Specified by:
- getFolderTagin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getGlossarypublic GetGlossaryResponse getGlossary(GetGlossaryRequest request) Description copied from interface:DataCatalogGets a specific glossary by key within a data catalog.- Specified by:
- getGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getJobpublic GetJobResponse getJob(GetJobRequest request) Description copied from interface:DataCatalogGets a specific job by key within a data catalog.- Specified by:
- getJobin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getJobDefinitionpublic GetJobDefinitionResponse getJobDefinition(GetJobDefinitionRequest request) Description copied from interface:DataCatalogGets a specific job definition by key within a data catalog.- Specified by:
- getJobDefinitionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getJobExecutionpublic GetJobExecutionResponse getJobExecution(GetJobExecutionRequest request) Description copied from interface:DataCatalogGets a specific job execution by key.- Specified by:
- getJobExecutionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getJobLogpublic GetJobLogResponse getJobLog(GetJobLogRequest request) Description copied from interface:DataCatalogGets a specific job log by key.- Specified by:
- getJobLogin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getJobMetricspublic GetJobMetricsResponse getJobMetrics(GetJobMetricsRequest request) Description copied from interface:DataCatalogGets a specific job metric by key.- Specified by:
- getJobMetricsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getMetastorepublic GetMetastoreResponse getMetastore(GetMetastoreRequest request) Description copied from interface:DataCatalogGets a metastore by identifier.- Specified by:
- getMetastorein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getNamespacepublic GetNamespaceResponse getNamespace(GetNamespaceRequest request) Description copied from interface:DataCatalogGets a specific namespace for the given key within a data catalog.- Specified by:
- getNamespacein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getPatternpublic GetPatternResponse getPattern(GetPatternRequest request) Description copied from interface:DataCatalogGets a specific pattern for the given key within a data catalog.- Specified by:
- getPatternin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getTermpublic GetTermResponse getTerm(GetTermRequest request) Description copied from interface:DataCatalogGets a specific glossary term by key.- Specified by:
- getTermin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getTermRelationshippublic GetTermRelationshipResponse getTermRelationship(GetTermRelationshipRequest request) Description copied from interface:DataCatalogGets a specific glossary term relationship by key.- Specified by:
- getTermRelationshipin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getTypepublic GetTypeResponse getType(GetTypeRequest request) Description copied from interface:DataCatalogGets a specific type by key within a data catalog.- Specified by:
- getTypein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWorkRequestpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request) Description copied from interface:DataCatalogGets the status of the work request with the given OCID.- Specified by:
- getWorkRequestin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
importConnectionpublic ImportConnectionResponse importConnection(ImportConnectionRequest request) Description copied from interface:DataCatalogImport new connection for this data asset.- Specified by:
- importConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
importDataAssetpublic ImportDataAssetResponse importDataAsset(ImportDataAssetRequest request) Description copied from interface:DataCatalogImport technical objects to a Data Asset- Specified by:
- importDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
importGlossarypublic ImportGlossaryResponse importGlossary(ImportGlossaryRequest request) Description copied from interface:DataCatalogImport the glossary and the terms from csv or json files and return the imported glossary resource.- Specified by:
- importGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
importLineagepublic ImportLineageResponse importLineage(ImportLineageRequest request) Description copied from interface:DataCatalogImports lineage metadata.Returns details about the job that performs the import. - Specified by:
- importLineagein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listAggregatedPhysicalEntitiespublic ListAggregatedPhysicalEntitiesResponse listAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest request) Description copied from interface:DataCatalogList the physical entities aggregated by this logical entity.- Specified by:
- listAggregatedPhysicalEntitiesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listAttributeTagspublic ListAttributeTagsResponse listAttributeTags(ListAttributeTagsRequest request) Description copied from interface:DataCatalogReturns a list of all tags for an entity attribute.- Specified by:
- listAttributeTagsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listAttributespublic ListAttributesResponse listAttributes(ListAttributesRequest request) Description copied from interface:DataCatalogReturns a list of all attributes of an data entity.- Specified by:
- listAttributesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listCatalogPrivateEndpointspublic ListCatalogPrivateEndpointsResponse listCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest request) Description copied from interface:DataCatalogReturns a list of all the catalog private endpoints in the specified compartment.- Specified by:
- listCatalogPrivateEndpointsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listCatalogspublic ListCatalogsResponse listCatalogs(ListCatalogsRequest request) Description copied from interface:DataCatalogReturns a list of all the data catalogs in the specified compartment.- Specified by:
- listCatalogsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listConnectionspublic ListConnectionsResponse listConnections(ListConnectionsRequest request) Description copied from interface:DataCatalogReturns a list of all Connections for a data asset.- Specified by:
- listConnectionsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listCustomPropertiespublic ListCustomPropertiesResponse listCustomProperties(ListCustomPropertiesRequest request) Description copied from interface:DataCatalogReturns a list of custom properties within a data catalog.- Specified by:
- listCustomPropertiesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listDataAssetTagspublic ListDataAssetTagsResponse listDataAssetTags(ListDataAssetTagsRequest request) Description copied from interface:DataCatalogReturns a list of all tags for a data asset.- Specified by:
- listDataAssetTagsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listDataAssetspublic ListDataAssetsResponse listDataAssets(ListDataAssetsRequest request) Description copied from interface:DataCatalogReturns a list of data assets within a data catalog.- Specified by:
- listDataAssetsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listDerivedLogicalEntitiespublic ListDerivedLogicalEntitiesResponse listDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest request) Description copied from interface:DataCatalogList logical entities derived from this pattern.- Specified by:
- listDerivedLogicalEntitiesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listEntitiespublic ListEntitiesResponse listEntities(ListEntitiesRequest request) Description copied from interface:DataCatalogReturns a list of all entities of a data asset.- Specified by:
- listEntitiesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listEntityTagspublic ListEntityTagsResponse listEntityTags(ListEntityTagsRequest request) Description copied from interface:DataCatalogReturns a list of all tags for a data entity.- Specified by:
- listEntityTagsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listFolderTagspublic ListFolderTagsResponse listFolderTags(ListFolderTagsRequest request) Description copied from interface:DataCatalogReturns a list of all tags for a folder.- Specified by:
- listFolderTagsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listFolderspublic ListFoldersResponse listFolders(ListFoldersRequest request) Description copied from interface:DataCatalogReturns a list of all folders.- Specified by:
- listFoldersin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listGlossariespublic ListGlossariesResponse listGlossaries(ListGlossariesRequest request) Description copied from interface:DataCatalogReturns a list of all glossaries within a data catalog.- Specified by:
- listGlossariesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listJobDefinitionspublic ListJobDefinitionsResponse listJobDefinitions(ListJobDefinitionsRequest request) Description copied from interface:DataCatalogReturns a list of job definitions within a data catalog.- Specified by:
- listJobDefinitionsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listJobExecutionspublic ListJobExecutionsResponse listJobExecutions(ListJobExecutionsRequest request) Description copied from interface:DataCatalogReturns a list of job executions for a job.- Specified by:
- listJobExecutionsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listJobLogspublic ListJobLogsResponse listJobLogs(ListJobLogsRequest request) Description copied from interface:DataCatalogReturns a list of job logs.- Specified by:
- listJobLogsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listJobMetricspublic ListJobMetricsResponse listJobMetrics(ListJobMetricsRequest request) Description copied from interface:DataCatalogReturns a list of job metrics.- Specified by:
- listJobMetricsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listJobspublic ListJobsResponse listJobs(ListJobsRequest request) Description copied from interface:DataCatalogReturns a list of jobs within a data catalog.- Specified by:
- listJobsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listMetastorespublic ListMetastoresResponse listMetastores(ListMetastoresRequest request) Description copied from interface:DataCatalogReturns a list of all metastores in the specified compartment.- Specified by:
- listMetastoresin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listNamespacespublic ListNamespacesResponse listNamespaces(ListNamespacesRequest request) Description copied from interface:DataCatalogReturns a list of namespaces within a data catalog.- Specified by:
- listNamespacesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listPatternspublic ListPatternsResponse listPatterns(ListPatternsRequest request) Description copied from interface:DataCatalogReturns a list of patterns within a data catalog.- Specified by:
- listPatternsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listRulespublic ListRulesResponse listRules(ListRulesRequest request) Description copied from interface:DataCatalogReturns a list of all rules of a data entity.- Specified by:
- listRulesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listTagspublic ListTagsResponse listTags(ListTagsRequest request) Description copied from interface:DataCatalogReturns a list of all user created tags in the system.- Specified by:
- listTagsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listTermRelationshipspublic ListTermRelationshipsResponse listTermRelationships(ListTermRelationshipsRequest request) Description copied from interface:DataCatalogReturns a list of all term relationships within a glossary.- Specified by:
- listTermRelationshipsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listTermspublic ListTermsResponse listTerms(ListTermsRequest request) Description copied from interface:DataCatalogReturns a list of all terms within a glossary.- Specified by:
- listTermsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listTypespublic ListTypesResponse listTypes(ListTypesRequest request) Description copied from interface:DataCatalogReturns a list of all types within a data catalog.- Specified by:
- listTypesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestErrorspublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request) Description copied from interface:DataCatalogReturns a (paginated) list of errors for a given work request.- Specified by:
- listWorkRequestErrorsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestLogspublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request) Description copied from interface:DataCatalogReturns a (paginated) list of logs for a given work request.- Specified by:
- listWorkRequestLogsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestspublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request) Description copied from interface:DataCatalogLists the work requests in a compartment.- Specified by:
- listWorkRequestsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
objectStatspublic ObjectStatsResponse objectStats(ObjectStatsRequest request) Description copied from interface:DataCatalogReturns stats on objects by type in the repository.- Specified by:
- objectStatsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
parseConnectionpublic ParseConnectionResponse parseConnection(ParseConnectionRequest request) Description copied from interface:DataCatalogParse data asset references through connections from this data asset.- Specified by:
- parseConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
processRecommendationpublic ProcessRecommendationResponse processRecommendation(ProcessRecommendationRequest request) Description copied from interface:DataCatalogAct 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. - Specified by:
- processRecommendationin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
recommendationspublic RecommendationsResponse recommendations(RecommendationsRequest request) Description copied from interface:DataCatalogReturns 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. - Specified by:
- recommendationsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeCatalogLockpublic RemoveCatalogLockResponse removeCatalogLock(RemoveCatalogLockRequest request) Description copied from interface:DataCatalogRemoves a lock from a Catalog resource.- Specified by:
- removeCatalogLockin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeCatalogPrivateEndpointLockpublic RemoveCatalogPrivateEndpointLockResponse removeCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest request) Description copied from interface:DataCatalogRemoves a lock from a CatalogPrivateEndpoint resource.- Specified by:
- removeCatalogPrivateEndpointLockin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeDataSelectorPatternspublic RemoveDataSelectorPatternsResponse removeDataSelectorPatterns(RemoveDataSelectorPatternsRequest request) Description copied from interface:DataCatalogRemove data selector pattern from the data asset.- Specified by:
- removeDataSelectorPatternsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
removeMetastoreLockpublic RemoveMetastoreLockResponse removeMetastoreLock(RemoveMetastoreLockRequest request) Description copied from interface:DataCatalogRemoves a lock from a Metastore resource.- Specified by:
- removeMetastoreLockin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
searchCriteriapublic SearchCriteriaResponse searchCriteria(SearchCriteriaRequest request) Description copied from interface:DataCatalogReturns a list of search results within a data catalog.- Specified by:
- searchCriteriain interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
suggestMatchespublic SuggestMatchesResponse suggestMatches(SuggestMatchesRequest request) Description copied from interface:DataCatalogReturns a list of potential string matches for a given input string.- Specified by:
- suggestMatchesin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
synchronousExportDataAssetpublic SynchronousExportDataAssetResponse synchronousExportDataAsset(SynchronousExportDataAssetRequest request) Description copied from interface:DataCatalogExport technical objects from a Data Asset- Specified by:
- synchronousExportDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
testConnectionpublic TestConnectionResponse testConnection(TestConnectionRequest request) Description copied from interface:DataCatalogTest the connection by connecting to the data asset using credentials in the metadata.- Specified by:
- testConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateAttributepublic UpdateAttributeResponse updateAttribute(UpdateAttributeRequest request) Description copied from interface:DataCatalogUpdates a specific data asset attribute.- Specified by:
- updateAttributein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateCatalogpublic UpdateCatalogResponse updateCatalog(UpdateCatalogRequest request) Description copied from interface:DataCatalogUpdates the data catalog.- Specified by:
- updateCatalogin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateCatalogPrivateEndpointpublic UpdateCatalogPrivateEndpointResponse updateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest request) Description copied from interface:DataCatalogUpdates the private reverse connection endpoint.- Specified by:
- updateCatalogPrivateEndpointin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateConnectionpublic UpdateConnectionResponse updateConnection(UpdateConnectionRequest request) Description copied from interface:DataCatalogUpdates a specific connection of a data asset.- Specified by:
- updateConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateCustomPropertypublic UpdateCustomPropertyResponse updateCustomProperty(UpdateCustomPropertyRequest request) Description copied from interface:DataCatalogUpdates a specific custom property identified by the given key.- Specified by:
- updateCustomPropertyin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateDataAssetpublic UpdateDataAssetResponse updateDataAsset(UpdateDataAssetRequest request) Description copied from interface:DataCatalogUpdates a specific data asset identified by the given key.- Specified by:
- updateDataAssetin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateEntitypublic UpdateEntityResponse updateEntity(UpdateEntityRequest request) Description copied from interface:DataCatalogUpdates a specific data entity.- Specified by:
- updateEntityin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateFolderpublic UpdateFolderResponse updateFolder(UpdateFolderRequest request) Description copied from interface:DataCatalogUpdates a specific folder of a data asset.- Specified by:
- updateFolderin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateGlossarypublic UpdateGlossaryResponse updateGlossary(UpdateGlossaryRequest request) Description copied from interface:DataCatalogUpdates a specific glossary identified by the given key.- Specified by:
- updateGlossaryin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateJobpublic UpdateJobResponse updateJob(UpdateJobRequest request) Description copied from interface:DataCatalogUpdates a specific job identified by the given key.- Specified by:
- updateJobin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateJobDefinitionpublic UpdateJobDefinitionResponse updateJobDefinition(UpdateJobDefinitionRequest request) Description copied from interface:DataCatalogUpdate a specific job definition identified by the given key.- Specified by:
- updateJobDefinitionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateMetastorepublic UpdateMetastoreResponse updateMetastore(UpdateMetastoreRequest request) Description copied from interface:DataCatalogUpdates a metastore resource by identifier.- Specified by:
- updateMetastorein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateNamespacepublic UpdateNamespaceResponse updateNamespace(UpdateNamespaceRequest request) Description copied from interface:DataCatalogUpdates a specific namespace identified by the given key.- Specified by:
- updateNamespacein interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updatePatternpublic UpdatePatternResponse updatePattern(UpdatePatternRequest request) Description copied from interface:DataCatalogUpdates a specific pattern identified by the given key.- Specified by:
- updatePatternin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateTermpublic UpdateTermResponse updateTerm(UpdateTermRequest request) Description copied from interface:DataCatalogUpdates a specific glossary term.- Specified by:
- updateTermin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateTermRelationshippublic UpdateTermRelationshipResponse updateTermRelationship(UpdateTermRelationshipRequest request) Description copied from interface:DataCatalogUpdates a specific glossary term relationship.- Specified by:
- updateTermRelationshipin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
uploadCredentialspublic UploadCredentialsResponse uploadCredentials(UploadCredentialsRequest request) Description copied from interface:DataCatalogUpload connection credentails and metadata for this connection.- Specified by:
- uploadCredentialsin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
userspublic UsersResponse users(UsersRequest request) Description copied from interface:DataCatalogReturns active users in the system.- Specified by:
- usersin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
validateConnectionpublic ValidateConnectionResponse validateConnection(ValidateConnectionRequest request) Description copied from interface:DataCatalogValidate connection by connecting to the data asset using credentials in metadata.- Specified by:
- validateConnectionin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
validatePatternpublic ValidatePatternResponse validatePattern(ValidatePatternRequest request) Description copied from interface:DataCatalogValidate pattern by deriving file groups representing logical entities using the expression- Specified by:
- validatePatternin interface- DataCatalog
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWaiterspublic DataCatalogWaiters getWaiters() Description copied from interface:DataCatalogGets the pre-configured waiters available for resources for this service.- Specified by:
- getWaitersin interface- DataCatalog
- Returns:
- The service waiters.
 
 - 
getPaginatorspublic DataCatalogPaginators getPaginators() Description copied from interface:DataCatalogGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
- getPaginatorsin interface- DataCatalog
- Returns:
- The service paginators.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false - Parameters:
- useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
 
 - 
populateServiceParametersInEndpointpublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank. - Parameters:
- endpoint- The endpoint template in use
- requiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
 
 - 
updateBaseEndpointpublic final void updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters. - Parameters:
- endpoint- The updated endpoint to use
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 
- 
 
-