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 Summary
Nested Classes Modifier and Type Class Description static classDataCatalogClient.BuilderBuilder class for this client.
-
Field Summary
Fields 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 Summary
Constructors 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 Summary
All 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.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.datacatalog.DataCatalog
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DataCatalogClient
@Deprecated public DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataCatalogClient.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 (seeDataCatalogClient.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 (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-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 (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-DataCatalogClient.Builder.executorService
-
-
Method Detail
-
builder
public static DataCatalogClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public 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 interfaceDataCatalog- Parameters:
region- The region of the service.
-
setRegion
public 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 interfaceDataCatalog- Parameters:
regionId- The public region ID.
-
addCatalogLock
public AddCatalogLockResponse addCatalogLock(AddCatalogLockRequest request)
Description copied from interface:DataCatalogAdds a lock to a Catalog resource.- Specified by:
addCatalogLockin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addCatalogPrivateEndpointLock
public AddCatalogPrivateEndpointLockResponse addCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest request)
Description copied from interface:DataCatalogAdds a lock to a CatalogPrivateEndpoint resource.- Specified by:
addCatalogPrivateEndpointLockin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addDataSelectorPatterns
public AddDataSelectorPatternsResponse addDataSelectorPatterns(AddDataSelectorPatternsRequest request)
Description copied from interface:DataCatalogAdd data selector pattern to the data asset.- Specified by:
addDataSelectorPatternsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
addMetastoreLock
public AddMetastoreLockResponse addMetastoreLock(AddMetastoreLockRequest request)
Description copied from interface:DataCatalogAdds a lock to a Metastore resource.- Specified by:
addMetastoreLockin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
associateCustomProperty
public AssociateCustomPropertyResponse associateCustomProperty(AssociateCustomPropertyRequest request)
Description copied from interface:DataCatalogAssociate the custom property for the given type- Specified by:
associateCustomPropertyin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
asynchronousExportDataAsset
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
asynchronousExportGlossary
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
attachCatalogPrivateEndpoint
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeCatalogCompartment
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeCatalogPrivateEndpointCompartment
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeMetastoreCompartment
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAttribute
public CreateAttributeResponse createAttribute(CreateAttributeRequest request)
Description copied from interface:DataCatalogCreates a new entity attribute.- Specified by:
createAttributein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createAttributeTag
public CreateAttributeTagResponse createAttributeTag(CreateAttributeTagRequest request)
Description copied from interface:DataCatalogCreates a new entity attribute tag.- Specified by:
createAttributeTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCatalog
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCatalogPrivateEndpoint
public CreateCatalogPrivateEndpointResponse createCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest request)
Description copied from interface:DataCatalogCreate a new private reverse connection endpoint.- Specified by:
createCatalogPrivateEndpointin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createConnection
public CreateConnectionResponse createConnection(CreateConnectionRequest request)
Description copied from interface:DataCatalogCreates a new connection.- Specified by:
createConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createCustomProperty
public CreateCustomPropertyResponse createCustomProperty(CreateCustomPropertyRequest request)
Description copied from interface:DataCatalogCreate a new Custom Property- Specified by:
createCustomPropertyin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataAsset
public CreateDataAssetResponse createDataAsset(CreateDataAssetRequest request)
Description copied from interface:DataCatalogCreate a new data asset.- Specified by:
createDataAssetin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataAssetTag
public CreateDataAssetTagResponse createDataAssetTag(CreateDataAssetTagRequest request)
Description copied from interface:DataCatalogCreates a new data asset tag.- Specified by:
createDataAssetTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createEntity
public CreateEntityResponse createEntity(CreateEntityRequest request)
Description copied from interface:DataCatalogCreates a new data entity.- Specified by:
createEntityin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createEntityTag
public CreateEntityTagResponse createEntityTag(CreateEntityTagRequest request)
Description copied from interface:DataCatalogCreates a new entity tag.- Specified by:
createEntityTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createFolder
public CreateFolderResponse createFolder(CreateFolderRequest request)
Description copied from interface:DataCatalogCreates a new folder.- Specified by:
createFolderin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createFolderTag
public CreateFolderTagResponse createFolderTag(CreateFolderTagRequest request)
Description copied from interface:DataCatalogCreates a new folder tag.- Specified by:
createFolderTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createGlossary
public CreateGlossaryResponse createGlossary(CreateGlossaryRequest request)
Description copied from interface:DataCatalogCreates a new glossary.- Specified by:
createGlossaryin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createJob
public CreateJobResponse createJob(CreateJobRequest request)
Description copied from interface:DataCatalogCreates a new job.- Specified by:
createJobin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createJobDefinition
public CreateJobDefinitionResponse createJobDefinition(CreateJobDefinitionRequest request)
Description copied from interface:DataCatalogCreates a new job definition.- Specified by:
createJobDefinitionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createJobExecution
public CreateJobExecutionResponse createJobExecution(CreateJobExecutionRequest request)
Description copied from interface:DataCatalogCreates a new job execution.- Specified by:
createJobExecutionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createMetastore
public CreateMetastoreResponse createMetastore(CreateMetastoreRequest request)
Description copied from interface:DataCatalogCreates a new metastore.- Specified by:
createMetastorein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createNamespace
public CreateNamespaceResponse createNamespace(CreateNamespaceRequest request)
Description copied from interface:DataCatalogCreate a new Namespace to be used by a custom property- Specified by:
createNamespacein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPattern
public CreatePatternResponse createPattern(CreatePatternRequest request)
Description copied from interface:DataCatalogCreate a new pattern.- Specified by:
createPatternin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTerm
public CreateTermResponse createTerm(CreateTermRequest request)
Description copied from interface:DataCatalogCreate a new term within a glossary.- Specified by:
createTermin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createTermRelationship
public CreateTermRelationshipResponse createTermRelationship(CreateTermRelationshipRequest request)
Description copied from interface:DataCatalogCreates a new term relationship for this term within a glossary.- Specified by:
createTermRelationshipin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAttribute
public DeleteAttributeResponse deleteAttribute(DeleteAttributeRequest request)
Description copied from interface:DataCatalogDeletes a specific entity attribute.- Specified by:
deleteAttributein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteAttributeTag
public DeleteAttributeTagResponse deleteAttributeTag(DeleteAttributeTagRequest request)
Description copied from interface:DataCatalogDeletes a specific entity attribute tag.- Specified by:
deleteAttributeTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCatalog
public DeleteCatalogResponse deleteCatalog(DeleteCatalogRequest request)
Description copied from interface:DataCatalogDeletes a data catalog resource by identifier.- Specified by:
deleteCatalogin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCatalogPrivateEndpoint
public DeleteCatalogPrivateEndpointResponse deleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest request)
Description copied from interface:DataCatalogDeletes a private reverse connection endpoint by identifier.- Specified by:
deleteCatalogPrivateEndpointin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteConnection
public DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Description copied from interface:DataCatalogDeletes a specific connection of a data asset.- Specified by:
deleteConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteCustomProperty
public DeleteCustomPropertyResponse deleteCustomProperty(DeleteCustomPropertyRequest request)
Description copied from interface:DataCatalogDeletes a specific custom property identified by it’s key.- Specified by:
deleteCustomPropertyin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataAsset
public DeleteDataAssetResponse deleteDataAsset(DeleteDataAssetRequest request)
Description copied from interface:DataCatalogDeletes a specific data asset identified by it’s key.- Specified by:
deleteDataAssetin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataAssetTag
public DeleteDataAssetTagResponse deleteDataAssetTag(DeleteDataAssetTagRequest request)
Description copied from interface:DataCatalogDeletes a specific data asset tag.- Specified by:
deleteDataAssetTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteEntity
public DeleteEntityResponse deleteEntity(DeleteEntityRequest request)
Description copied from interface:DataCatalogDeletes a specific data entity.- Specified by:
deleteEntityin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteEntityTag
public DeleteEntityTagResponse deleteEntityTag(DeleteEntityTagRequest request)
Description copied from interface:DataCatalogDeletes a specific entity tag.- Specified by:
deleteEntityTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteFolder
public DeleteFolderResponse deleteFolder(DeleteFolderRequest request)
Description copied from interface:DataCatalogDeletes a specific folder of a data asset identified by it’s key.- Specified by:
deleteFolderin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteFolderTag
public DeleteFolderTagResponse deleteFolderTag(DeleteFolderTagRequest request)
Description copied from interface:DataCatalogDeletes a specific folder tag.- Specified by:
deleteFolderTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteGlossary
public DeleteGlossaryResponse deleteGlossary(DeleteGlossaryRequest request)
Description copied from interface:DataCatalogDeletes a specific glossary identified by it’s key.- Specified by:
deleteGlossaryin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteJob
public DeleteJobResponse deleteJob(DeleteJobRequest request)
Description copied from interface:DataCatalogDeletes a specific job identified by it’s key.- Specified by:
deleteJobin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteJobDefinition
public DeleteJobDefinitionResponse deleteJobDefinition(DeleteJobDefinitionRequest request)
Description copied from interface:DataCatalogDeletes a specific job definition identified by it’s key.- Specified by:
deleteJobDefinitionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMetastore
public DeleteMetastoreResponse deleteMetastore(DeleteMetastoreRequest request)
Description copied from interface:DataCatalogDeletes a metastore resource by identifier.- Specified by:
deleteMetastorein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteNamespace
public DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest request)
Description copied from interface:DataCatalogDeletes a specific Namespace identified by it’s key.- Specified by:
deleteNamespacein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePattern
public DeletePatternResponse deletePattern(DeletePatternRequest request)
Description copied from interface:DataCatalogDeletes a specific pattern identified by it’s key.- Specified by:
deletePatternin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTerm
public DeleteTermResponse deleteTerm(DeleteTermRequest request)
Description copied from interface:DataCatalogDeletes a specific glossary term.- Specified by:
deleteTermin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteTermRelationship
public DeleteTermRelationshipResponse deleteTermRelationship(DeleteTermRelationshipRequest request)
Description copied from interface:DataCatalogDeletes a specific glossary term relationship.- Specified by:
deleteTermRelationshipin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
detachCatalogPrivateEndpoint
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
disassociateCustomProperty
public DisassociateCustomPropertyResponse disassociateCustomProperty(DisassociateCustomPropertyRequest request)
Description copied from interface:DataCatalogRemove the custom property for the given type- Specified by:
disassociateCustomPropertyin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
expandTreeForGlossary
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportGlossary
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
fetchEntityLineage
public FetchEntityLineageResponse fetchEntityLineage(FetchEntityLineageRequest request)
Description copied from interface:DataCatalogReturns lineage for a given entity object.- Specified by:
fetchEntityLineagein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAttribute
public GetAttributeResponse getAttribute(GetAttributeRequest request)
Description copied from interface:DataCatalogGets a specific entity attribute by key.- Specified by:
getAttributein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAttributeTag
public GetAttributeTagResponse getAttributeTag(GetAttributeTagRequest request)
Description copied from interface:DataCatalogGets a specific entity attribute tag by key.- Specified by:
getAttributeTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCatalog
public GetCatalogResponse getCatalog(GetCatalogRequest request)
Description copied from interface:DataCatalogGets a data catalog by identifier.- Specified by:
getCatalogin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCatalogPrivateEndpoint
public GetCatalogPrivateEndpointResponse getCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest request)
Description copied from interface:DataCatalogGets a specific private reverse connection by identifier.- Specified by:
getCatalogPrivateEndpointin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getConnection
public GetConnectionResponse getConnection(GetConnectionRequest request)
Description copied from interface:DataCatalogGets a specific data asset connection by key.- Specified by:
getConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getCustomProperty
public GetCustomPropertyResponse getCustomProperty(GetCustomPropertyRequest request)
Description copied from interface:DataCatalogGets a specific custom property for the given key within a data catalog.- Specified by:
getCustomPropertyin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataAsset
public GetDataAssetResponse getDataAsset(GetDataAssetRequest request)
Description copied from interface:DataCatalogGets a specific data asset for the given key within a data catalog.- Specified by:
getDataAssetin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getDataAssetTag
public GetDataAssetTagResponse getDataAssetTag(GetDataAssetTagRequest request)
Description copied from interface:DataCatalogGets a specific data asset tag by key.- Specified by:
getDataAssetTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getEntity
public GetEntityResponse getEntity(GetEntityRequest request)
Description copied from interface:DataCatalogGets a specific data entity by key for a data asset.- Specified by:
getEntityin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getEntityTag
public GetEntityTagResponse getEntityTag(GetEntityTagRequest request)
Description copied from interface:DataCatalogGets a specific entity tag by key.- Specified by:
getEntityTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFolder
public GetFolderResponse getFolder(GetFolderRequest request)
Description copied from interface:DataCatalogGets a specific data asset folder by key.- Specified by:
getFolderin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getFolderTag
public GetFolderTagResponse getFolderTag(GetFolderTagRequest request)
Description copied from interface:DataCatalogGets a specific folder tag by key.- Specified by:
getFolderTagin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getGlossary
public GetGlossaryResponse getGlossary(GetGlossaryRequest request)
Description copied from interface:DataCatalogGets a specific glossary by key within a data catalog.- Specified by:
getGlossaryin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJob
public GetJobResponse getJob(GetJobRequest request)
Description copied from interface:DataCatalogGets a specific job by key within a data catalog.- Specified by:
getJobin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobDefinition
public GetJobDefinitionResponse getJobDefinition(GetJobDefinitionRequest request)
Description copied from interface:DataCatalogGets a specific job definition by key within a data catalog.- Specified by:
getJobDefinitionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobExecution
public GetJobExecutionResponse getJobExecution(GetJobExecutionRequest request)
Description copied from interface:DataCatalogGets a specific job execution by key.- Specified by:
getJobExecutionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobLog
public GetJobLogResponse getJobLog(GetJobLogRequest request)
Description copied from interface:DataCatalogGets a specific job log by key.- Specified by:
getJobLogin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getJobMetrics
public GetJobMetricsResponse getJobMetrics(GetJobMetricsRequest request)
Description copied from interface:DataCatalogGets a specific job metric by key.- Specified by:
getJobMetricsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMetastore
public GetMetastoreResponse getMetastore(GetMetastoreRequest request)
Description copied from interface:DataCatalogGets a metastore by identifier.- Specified by:
getMetastorein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getNamespace
public GetNamespaceResponse getNamespace(GetNamespaceRequest request)
Description copied from interface:DataCatalogGets a specific namespace for the given key within a data catalog.- Specified by:
getNamespacein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPattern
public GetPatternResponse getPattern(GetPatternRequest request)
Description copied from interface:DataCatalogGets a specific pattern for the given key within a data catalog.- Specified by:
getPatternin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTerm
public GetTermResponse getTerm(GetTermRequest request)
Description copied from interface:DataCatalogGets a specific glossary term by key.- Specified by:
getTermin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getTermRelationship
public GetTermRelationshipResponse getTermRelationship(GetTermRelationshipRequest request)
Description copied from interface:DataCatalogGets a specific glossary term relationship by key.- Specified by:
getTermRelationshipin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getType
public GetTypeResponse getType(GetTypeRequest request)
Description copied from interface:DataCatalogGets a specific type by key within a data catalog.- Specified by:
getTypein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:DataCatalogGets the status of the work request with the given OCID.- Specified by:
getWorkRequestin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importConnection
public ImportConnectionResponse importConnection(ImportConnectionRequest request)
Description copied from interface:DataCatalogImport new connection for this data asset.- Specified by:
importConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importDataAsset
public ImportDataAssetResponse importDataAsset(ImportDataAssetRequest request)
Description copied from interface:DataCatalogImport technical objects to a Data Asset- Specified by:
importDataAssetin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importGlossary
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importLineage
public ImportLineageResponse importLineage(ImportLineageRequest request)
Description copied from interface:DataCatalogImports lineage metadata.Returns details about the job that performs the import.
- Specified by:
importLineagein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAggregatedPhysicalEntities
public ListAggregatedPhysicalEntitiesResponse listAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest request)
Description copied from interface:DataCatalogList the physical entities aggregated by this logical entity.- Specified by:
listAggregatedPhysicalEntitiesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAttributeTags
public ListAttributeTagsResponse listAttributeTags(ListAttributeTagsRequest request)
Description copied from interface:DataCatalogReturns a list of all tags for an entity attribute.- Specified by:
listAttributeTagsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAttributes
public ListAttributesResponse listAttributes(ListAttributesRequest request)
Description copied from interface:DataCatalogReturns a list of all attributes of an data entity.- Specified by:
listAttributesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCatalogPrivateEndpoints
public ListCatalogPrivateEndpointsResponse listCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest request)
Description copied from interface:DataCatalogReturns a list of all the catalog private endpoints in the specified compartment.- Specified by:
listCatalogPrivateEndpointsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCatalogs
public ListCatalogsResponse listCatalogs(ListCatalogsRequest request)
Description copied from interface:DataCatalogReturns a list of all the data catalogs in the specified compartment.- Specified by:
listCatalogsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listConnections
public ListConnectionsResponse listConnections(ListConnectionsRequest request)
Description copied from interface:DataCatalogReturns a list of all Connections for a data asset.- Specified by:
listConnectionsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listCustomProperties
public ListCustomPropertiesResponse listCustomProperties(ListCustomPropertiesRequest request)
Description copied from interface:DataCatalogReturns a list of custom properties within a data catalog.- Specified by:
listCustomPropertiesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataAssetTags
public ListDataAssetTagsResponse listDataAssetTags(ListDataAssetTagsRequest request)
Description copied from interface:DataCatalogReturns a list of all tags for a data asset.- Specified by:
listDataAssetTagsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDataAssets
public ListDataAssetsResponse listDataAssets(ListDataAssetsRequest request)
Description copied from interface:DataCatalogReturns a list of data assets within a data catalog.- Specified by:
listDataAssetsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDerivedLogicalEntities
public ListDerivedLogicalEntitiesResponse listDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest request)
Description copied from interface:DataCatalogList logical entities derived from this pattern.- Specified by:
listDerivedLogicalEntitiesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEntities
public ListEntitiesResponse listEntities(ListEntitiesRequest request)
Description copied from interface:DataCatalogReturns a list of all entities of a data asset.- Specified by:
listEntitiesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listEntityTags
public ListEntityTagsResponse listEntityTags(ListEntityTagsRequest request)
Description copied from interface:DataCatalogReturns a list of all tags for a data entity.- Specified by:
listEntityTagsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFolderTags
public ListFolderTagsResponse listFolderTags(ListFolderTagsRequest request)
Description copied from interface:DataCatalogReturns a list of all tags for a folder.- Specified by:
listFolderTagsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listFolders
public ListFoldersResponse listFolders(ListFoldersRequest request)
Description copied from interface:DataCatalogReturns a list of all folders.- Specified by:
listFoldersin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listGlossaries
public ListGlossariesResponse listGlossaries(ListGlossariesRequest request)
Description copied from interface:DataCatalogReturns a list of all glossaries within a data catalog.- Specified by:
listGlossariesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobDefinitions
public ListJobDefinitionsResponse listJobDefinitions(ListJobDefinitionsRequest request)
Description copied from interface:DataCatalogReturns a list of job definitions within a data catalog.- Specified by:
listJobDefinitionsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobExecutions
public ListJobExecutionsResponse listJobExecutions(ListJobExecutionsRequest request)
Description copied from interface:DataCatalogReturns a list of job executions for a job.- Specified by:
listJobExecutionsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobLogs
public ListJobLogsResponse listJobLogs(ListJobLogsRequest request)
Description copied from interface:DataCatalogReturns a list of job logs.- Specified by:
listJobLogsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobMetrics
public ListJobMetricsResponse listJobMetrics(ListJobMetricsRequest request)
Description copied from interface:DataCatalogReturns a list of job metrics.- Specified by:
listJobMetricsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listJobs
public ListJobsResponse listJobs(ListJobsRequest request)
Description copied from interface:DataCatalogReturns a list of jobs within a data catalog.- Specified by:
listJobsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMetastores
public ListMetastoresResponse listMetastores(ListMetastoresRequest request)
Description copied from interface:DataCatalogReturns a list of all metastores in the specified compartment.- Specified by:
listMetastoresin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listNamespaces
public ListNamespacesResponse listNamespaces(ListNamespacesRequest request)
Description copied from interface:DataCatalogReturns a list of namespaces within a data catalog.- Specified by:
listNamespacesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPatterns
public ListPatternsResponse listPatterns(ListPatternsRequest request)
Description copied from interface:DataCatalogReturns a list of patterns within a data catalog.- Specified by:
listPatternsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listRules
public ListRulesResponse listRules(ListRulesRequest request)
Description copied from interface:DataCatalogReturns a list of all rules of a data entity.- Specified by:
listRulesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTags
public ListTagsResponse listTags(ListTagsRequest request)
Description copied from interface:DataCatalogReturns a list of all user created tags in the system.- Specified by:
listTagsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTermRelationships
public ListTermRelationshipsResponse listTermRelationships(ListTermRelationshipsRequest request)
Description copied from interface:DataCatalogReturns a list of all term relationships within a glossary.- Specified by:
listTermRelationshipsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTerms
public ListTermsResponse listTerms(ListTermsRequest request)
Description copied from interface:DataCatalogReturns a list of all terms within a glossary.- Specified by:
listTermsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listTypes
public ListTypesResponse listTypes(ListTypesRequest request)
Description copied from interface:DataCatalogReturns a list of all types within a data catalog.- Specified by:
listTypesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:DataCatalogReturns a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrorsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:DataCatalogReturns a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:DataCatalogLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
objectStats
public ObjectStatsResponse objectStats(ObjectStatsRequest request)
Description copied from interface:DataCatalogReturns stats on objects by type in the repository.- Specified by:
objectStatsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
parseConnection
public ParseConnectionResponse parseConnection(ParseConnectionRequest request)
Description copied from interface:DataCatalogParse data asset references through connections from this data asset.- Specified by:
parseConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
processRecommendation
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
recommendations
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeCatalogLock
public RemoveCatalogLockResponse removeCatalogLock(RemoveCatalogLockRequest request)
Description copied from interface:DataCatalogRemoves a lock from a Catalog resource.- Specified by:
removeCatalogLockin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeCatalogPrivateEndpointLock
public RemoveCatalogPrivateEndpointLockResponse removeCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest request)
Description copied from interface:DataCatalogRemoves a lock from a CatalogPrivateEndpoint resource.- Specified by:
removeCatalogPrivateEndpointLockin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeDataSelectorPatterns
public RemoveDataSelectorPatternsResponse removeDataSelectorPatterns(RemoveDataSelectorPatternsRequest request)
Description copied from interface:DataCatalogRemove data selector pattern from the data asset.- Specified by:
removeDataSelectorPatternsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeMetastoreLock
public RemoveMetastoreLockResponse removeMetastoreLock(RemoveMetastoreLockRequest request)
Description copied from interface:DataCatalogRemoves a lock from a Metastore resource.- Specified by:
removeMetastoreLockin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
searchCriteria
public SearchCriteriaResponse searchCriteria(SearchCriteriaRequest request)
Description copied from interface:DataCatalogReturns a list of search results within a data catalog.- Specified by:
searchCriteriain interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
suggestMatches
public SuggestMatchesResponse suggestMatches(SuggestMatchesRequest request)
Description copied from interface:DataCatalogReturns a list of potential string matches for a given input string.- Specified by:
suggestMatchesin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
synchronousExportDataAsset
public SynchronousExportDataAssetResponse synchronousExportDataAsset(SynchronousExportDataAssetRequest request)
Description copied from interface:DataCatalogExport technical objects from a Data Asset- Specified by:
synchronousExportDataAssetin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
testConnection
public 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 interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateAttribute
public UpdateAttributeResponse updateAttribute(UpdateAttributeRequest request)
Description copied from interface:DataCatalogUpdates a specific data asset attribute.- Specified by:
updateAttributein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCatalog
public UpdateCatalogResponse updateCatalog(UpdateCatalogRequest request)
Description copied from interface:DataCatalogUpdates the data catalog.- Specified by:
updateCatalogin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCatalogPrivateEndpoint
public UpdateCatalogPrivateEndpointResponse updateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest request)
Description copied from interface:DataCatalogUpdates the private reverse connection endpoint.- Specified by:
updateCatalogPrivateEndpointin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateConnection
public UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Description copied from interface:DataCatalogUpdates a specific connection of a data asset.- Specified by:
updateConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateCustomProperty
public UpdateCustomPropertyResponse updateCustomProperty(UpdateCustomPropertyRequest request)
Description copied from interface:DataCatalogUpdates a specific custom property identified by the given key.- Specified by:
updateCustomPropertyin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataAsset
public UpdateDataAssetResponse updateDataAsset(UpdateDataAssetRequest request)
Description copied from interface:DataCatalogUpdates a specific data asset identified by the given key.- Specified by:
updateDataAssetin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateEntity
public UpdateEntityResponse updateEntity(UpdateEntityRequest request)
Description copied from interface:DataCatalogUpdates a specific data entity.- Specified by:
updateEntityin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateFolder
public UpdateFolderResponse updateFolder(UpdateFolderRequest request)
Description copied from interface:DataCatalogUpdates a specific folder of a data asset.- Specified by:
updateFolderin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateGlossary
public UpdateGlossaryResponse updateGlossary(UpdateGlossaryRequest request)
Description copied from interface:DataCatalogUpdates a specific glossary identified by the given key.- Specified by:
updateGlossaryin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateJob
public UpdateJobResponse updateJob(UpdateJobRequest request)
Description copied from interface:DataCatalogUpdates a specific job identified by the given key.- Specified by:
updateJobin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateJobDefinition
public UpdateJobDefinitionResponse updateJobDefinition(UpdateJobDefinitionRequest request)
Description copied from interface:DataCatalogUpdate a specific job definition identified by the given key.- Specified by:
updateJobDefinitionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMetastore
public UpdateMetastoreResponse updateMetastore(UpdateMetastoreRequest request)
Description copied from interface:DataCatalogUpdates a metastore resource by identifier.- Specified by:
updateMetastorein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateNamespace
public UpdateNamespaceResponse updateNamespace(UpdateNamespaceRequest request)
Description copied from interface:DataCatalogUpdates a specific namespace identified by the given key.- Specified by:
updateNamespacein interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePattern
public UpdatePatternResponse updatePattern(UpdatePatternRequest request)
Description copied from interface:DataCatalogUpdates a specific pattern identified by the given key.- Specified by:
updatePatternin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTerm
public UpdateTermResponse updateTerm(UpdateTermRequest request)
Description copied from interface:DataCatalogUpdates a specific glossary term.- Specified by:
updateTermin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateTermRelationship
public UpdateTermRelationshipResponse updateTermRelationship(UpdateTermRelationshipRequest request)
Description copied from interface:DataCatalogUpdates a specific glossary term relationship.- Specified by:
updateTermRelationshipin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
uploadCredentials
public UploadCredentialsResponse uploadCredentials(UploadCredentialsRequest request)
Description copied from interface:DataCatalogUpload connection credentails and metadata for this connection.- Specified by:
uploadCredentialsin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
users
public UsersResponse users(UsersRequest request)
Description copied from interface:DataCatalogReturns active users in the system.- Specified by:
usersin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateConnection
public ValidateConnectionResponse validateConnection(ValidateConnectionRequest request)
Description copied from interface:DataCatalogValidate connection by connecting to the data asset using credentials in metadata.- Specified by:
validateConnectionin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validatePattern
public ValidatePatternResponse validatePattern(ValidatePatternRequest request)
Description copied from interface:DataCatalogValidate pattern by deriving file groups representing logical entities using the expression- Specified by:
validatePatternin interfaceDataCatalog- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DataCatalogWaiters getWaiters()
Description copied from interface:DataCatalogGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDataCatalog- Returns:
- The service waiters.
-
getPaginators
public 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 interfaceDataCatalog- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public 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
-
populateServiceParametersInEndpoint
public 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 userequiredParametersMap- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public 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
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-