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 class
DataCatalogClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for DataCatalog.
-
Constructor Summary
Constructors Constructor Description DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DataCatalogClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddCatalogLockResponse
addCatalogLock(AddCatalogLockRequest request)
Adds a lock to a Catalog resource.AddCatalogPrivateEndpointLockResponse
addCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest request)
Adds a lock to a CatalogPrivateEndpoint resource.AddDataSelectorPatternsResponse
addDataSelectorPatterns(AddDataSelectorPatternsRequest request)
Add data selector pattern to the data asset.AddMetastoreLockResponse
addMetastoreLock(AddMetastoreLockRequest request)
Adds a lock to a Metastore resource.AssociateCustomPropertyResponse
associateCustomProperty(AssociateCustomPropertyRequest request)
Associate the custom property for the given typeAsynchronousExportDataAssetResponse
asynchronousExportDataAsset(AsynchronousExportDataAssetRequest request)
Export technical objects from a Data Asset in Excel format.AsynchronousExportGlossaryResponse
asynchronousExportGlossary(AsynchronousExportGlossaryRequest request)
Exports the contents of a glossary in Excel format.AttachCatalogPrivateEndpointResponse
attachCatalogPrivateEndpoint(AttachCatalogPrivateEndpointRequest request)
Attaches a private reverse connection endpoint resource to a data catalog resource.static DataCatalogClient.Builder
builder()
Create a builder for this client.ChangeCatalogCompartmentResponse
changeCatalogCompartment(ChangeCatalogCompartmentRequest request)
Moves a resource into a different compartment.ChangeCatalogPrivateEndpointCompartmentResponse
changeCatalogPrivateEndpointCompartment(ChangeCatalogPrivateEndpointCompartmentRequest request)
Moves a resource into a different compartment.ChangeMetastoreCompartmentResponse
changeMetastoreCompartment(ChangeMetastoreCompartmentRequest request)
Moves a resource into a different compartment.void
close()
CreateAttributeResponse
createAttribute(CreateAttributeRequest request)
Creates a new entity attribute.CreateAttributeTagResponse
createAttributeTag(CreateAttributeTagRequest request)
Creates a new entity attribute tag.CreateCatalogResponse
createCatalog(CreateCatalogRequest request)
Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.CreateCatalogPrivateEndpointResponse
createCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest request)
Create a new private reverse connection endpoint.CreateConnectionResponse
createConnection(CreateConnectionRequest request)
Creates a new connection.CreateCustomPropertyResponse
createCustomProperty(CreateCustomPropertyRequest request)
Create a new Custom PropertyCreateDataAssetResponse
createDataAsset(CreateDataAssetRequest request)
Create a new data asset.CreateDataAssetTagResponse
createDataAssetTag(CreateDataAssetTagRequest request)
Creates a new data asset tag.CreateEntityResponse
createEntity(CreateEntityRequest request)
Creates a new data entity.CreateEntityTagResponse
createEntityTag(CreateEntityTagRequest request)
Creates a new entity tag.CreateFolderResponse
createFolder(CreateFolderRequest request)
Creates a new folder.CreateFolderTagResponse
createFolderTag(CreateFolderTagRequest request)
Creates a new folder tag.CreateGlossaryResponse
createGlossary(CreateGlossaryRequest request)
Creates a new glossary.CreateJobResponse
createJob(CreateJobRequest request)
Creates a new job.CreateJobDefinitionResponse
createJobDefinition(CreateJobDefinitionRequest request)
Creates a new job definition.CreateJobExecutionResponse
createJobExecution(CreateJobExecutionRequest request)
Creates a new job execution.CreateMetastoreResponse
createMetastore(CreateMetastoreRequest request)
Creates a new metastore.CreateNamespaceResponse
createNamespace(CreateNamespaceRequest request)
Create a new Namespace to be used by a custom propertyCreatePatternResponse
createPattern(CreatePatternRequest request)
Create a new pattern.CreateTermResponse
createTerm(CreateTermRequest request)
Create a new term within a glossary.CreateTermRelationshipResponse
createTermRelationship(CreateTermRelationshipRequest request)
Creates a new term relationship for this term within a glossary.DeleteAttributeResponse
deleteAttribute(DeleteAttributeRequest request)
Deletes a specific entity attribute.DeleteAttributeTagResponse
deleteAttributeTag(DeleteAttributeTagRequest request)
Deletes a specific entity attribute tag.DeleteCatalogResponse
deleteCatalog(DeleteCatalogRequest request)
Deletes a data catalog resource by identifier.DeleteCatalogPrivateEndpointResponse
deleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest request)
Deletes a private reverse connection endpoint by identifier.DeleteConnectionResponse
deleteConnection(DeleteConnectionRequest request)
Deletes a specific connection of a data asset.DeleteCustomPropertyResponse
deleteCustomProperty(DeleteCustomPropertyRequest request)
Deletes a specific custom property identified by it’s key.DeleteDataAssetResponse
deleteDataAsset(DeleteDataAssetRequest request)
Deletes a specific data asset identified by it’s key.DeleteDataAssetTagResponse
deleteDataAssetTag(DeleteDataAssetTagRequest request)
Deletes a specific data asset tag.DeleteEntityResponse
deleteEntity(DeleteEntityRequest request)
Deletes a specific data entity.DeleteEntityTagResponse
deleteEntityTag(DeleteEntityTagRequest request)
Deletes a specific entity tag.DeleteFolderResponse
deleteFolder(DeleteFolderRequest request)
Deletes a specific folder of a data asset identified by it’s key.DeleteFolderTagResponse
deleteFolderTag(DeleteFolderTagRequest request)
Deletes a specific folder tag.DeleteGlossaryResponse
deleteGlossary(DeleteGlossaryRequest request)
Deletes a specific glossary identified by it’s key.DeleteJobResponse
deleteJob(DeleteJobRequest request)
Deletes a specific job identified by it’s key.DeleteJobDefinitionResponse
deleteJobDefinition(DeleteJobDefinitionRequest request)
Deletes a specific job definition identified by it’s key.DeleteMetastoreResponse
deleteMetastore(DeleteMetastoreRequest request)
Deletes a metastore resource by identifier.DeleteNamespaceResponse
deleteNamespace(DeleteNamespaceRequest request)
Deletes a specific Namespace identified by it’s key.DeletePatternResponse
deletePattern(DeletePatternRequest request)
Deletes a specific pattern identified by it’s key.DeleteTermResponse
deleteTerm(DeleteTermRequest request)
Deletes a specific glossary term.DeleteTermRelationshipResponse
deleteTermRelationship(DeleteTermRelationshipRequest request)
Deletes a specific glossary term relationship.DetachCatalogPrivateEndpointResponse
detachCatalogPrivateEndpoint(DetachCatalogPrivateEndpointRequest request)
Detaches a private reverse connection endpoint resource to a data catalog resource.DisassociateCustomPropertyResponse
disassociateCustomProperty(DisassociateCustomPropertyRequest request)
Remove the custom property for the given typeExpandTreeForGlossaryResponse
expandTreeForGlossary(ExpandTreeForGlossaryRequest request)
Returns the fully expanded tree hierarchy of parent and child terms in this glossary.ExportGlossaryResponse
exportGlossary(ExportGlossaryRequest request)
Export the glossary and the terms and return the exported glossary as csv or json.FetchEntityLineageResponse
fetchEntityLineage(FetchEntityLineageRequest request)
Returns lineage for a given entity object.GetAttributeResponse
getAttribute(GetAttributeRequest request)
Gets a specific entity attribute by key.GetAttributeTagResponse
getAttributeTag(GetAttributeTagRequest request)
Gets a specific entity attribute tag by key.GetCatalogResponse
getCatalog(GetCatalogRequest request)
Gets a data catalog by identifier.GetCatalogPrivateEndpointResponse
getCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest request)
Gets a specific private reverse connection by identifier.String
getClientCommonLibraryVersion()
GetConnectionResponse
getConnection(GetConnectionRequest request)
Gets a specific data asset connection by key.GetCustomPropertyResponse
getCustomProperty(GetCustomPropertyRequest request)
Gets a specific custom property for the given key within a data catalog.GetDataAssetResponse
getDataAsset(GetDataAssetRequest request)
Gets a specific data asset for the given key within a data catalog.GetDataAssetTagResponse
getDataAssetTag(GetDataAssetTagRequest request)
Gets a specific data asset tag by key.protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetEntityResponse
getEntity(GetEntityRequest request)
Gets a specific data entity by key for a data asset.GetEntityTagResponse
getEntityTag(GetEntityTagRequest request)
Gets a specific entity tag by key.GetFolderResponse
getFolder(GetFolderRequest request)
Gets a specific data asset folder by key.GetFolderTagResponse
getFolderTag(GetFolderTagRequest request)
Gets a specific folder tag by key.GetGlossaryResponse
getGlossary(GetGlossaryRequest request)
Gets a specific glossary by key within a data catalog.GetJobResponse
getJob(GetJobRequest request)
Gets a specific job by key within a data catalog.GetJobDefinitionResponse
getJobDefinition(GetJobDefinitionRequest request)
Gets a specific job definition by key within a data catalog.GetJobExecutionResponse
getJobExecution(GetJobExecutionRequest request)
Gets a specific job execution by key.GetJobLogResponse
getJobLog(GetJobLogRequest request)
Gets a specific job log by key.GetJobMetricsResponse
getJobMetrics(GetJobMetricsRequest request)
Gets a specific job metric by key.GetMetastoreResponse
getMetastore(GetMetastoreRequest request)
Gets a metastore by identifier.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
GetNamespaceResponse
getNamespace(GetNamespaceRequest request)
Gets a specific namespace for the given key within a data catalog.DataCatalogPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetPatternResponse
getPattern(GetPatternRequest request)
Gets a specific pattern for the given key within a data catalog.GetTermResponse
getTerm(GetTermRequest request)
Gets a specific glossary term by key.GetTermRelationshipResponse
getTermRelationship(GetTermRelationshipRequest request)
Gets a specific glossary term relationship by key.GetTypeResponse
getType(GetTypeRequest request)
Gets a specific type by key within a data catalog.DataCatalogWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given OCID.ImportConnectionResponse
importConnection(ImportConnectionRequest request)
Import new connection for this data asset.ImportDataAssetResponse
importDataAsset(ImportDataAssetRequest request)
Import technical objects to a Data AssetImportGlossaryResponse
importGlossary(ImportGlossaryRequest request)
Import the glossary and the terms from csv or json files and return the imported glossary resource.ImportLineageResponse
importLineage(ImportLineageRequest request)
Imports lineage metadata.ListAggregatedPhysicalEntitiesResponse
listAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest request)
List the physical entities aggregated by this logical entity.ListAttributesResponse
listAttributes(ListAttributesRequest request)
Returns a list of all attributes of an data entity.ListAttributeTagsResponse
listAttributeTags(ListAttributeTagsRequest request)
Returns a list of all tags for an entity attribute.ListCatalogPrivateEndpointsResponse
listCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest request)
Returns a list of all the catalog private endpoints in the specified compartment.ListCatalogsResponse
listCatalogs(ListCatalogsRequest request)
Returns a list of all the data catalogs in the specified compartment.ListConnectionsResponse
listConnections(ListConnectionsRequest request)
Returns a list of all Connections for a data asset.ListCustomPropertiesResponse
listCustomProperties(ListCustomPropertiesRequest request)
Returns a list of custom properties within a data catalog.ListDataAssetsResponse
listDataAssets(ListDataAssetsRequest request)
Returns a list of data assets within a data catalog.ListDataAssetTagsResponse
listDataAssetTags(ListDataAssetTagsRequest request)
Returns a list of all tags for a data asset.ListDerivedLogicalEntitiesResponse
listDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest request)
List logical entities derived from this pattern.ListEntitiesResponse
listEntities(ListEntitiesRequest request)
Returns a list of all entities of a data asset.ListEntityTagsResponse
listEntityTags(ListEntityTagsRequest request)
Returns a list of all tags for a data entity.ListFoldersResponse
listFolders(ListFoldersRequest request)
Returns a list of all folders.ListFolderTagsResponse
listFolderTags(ListFolderTagsRequest request)
Returns a list of all tags for a folder.ListGlossariesResponse
listGlossaries(ListGlossariesRequest request)
Returns a list of all glossaries within a data catalog.ListJobDefinitionsResponse
listJobDefinitions(ListJobDefinitionsRequest request)
Returns a list of job definitions within a data catalog.ListJobExecutionsResponse
listJobExecutions(ListJobExecutionsRequest request)
Returns a list of job executions for a job.ListJobLogsResponse
listJobLogs(ListJobLogsRequest request)
Returns a list of job logs.ListJobMetricsResponse
listJobMetrics(ListJobMetricsRequest request)
Returns a list of job metrics.ListJobsResponse
listJobs(ListJobsRequest request)
Returns a list of jobs within a data catalog.ListMetastoresResponse
listMetastores(ListMetastoresRequest request)
Returns a list of all metastores in the specified compartment.ListNamespacesResponse
listNamespaces(ListNamespacesRequest request)
Returns a list of namespaces within a data catalog.ListPatternsResponse
listPatterns(ListPatternsRequest request)
Returns a list of patterns within a data catalog.ListRulesResponse
listRules(ListRulesRequest request)
Returns a list of all rules of a data entity.ListTagsResponse
listTags(ListTagsRequest request)
Returns a list of all user created tags in the system.ListTermRelationshipsResponse
listTermRelationships(ListTermRelationshipsRequest request)
Returns a list of all term relationships within a glossary.ListTermsResponse
listTerms(ListTermsRequest request)
Returns a list of all terms within a glossary.ListTypesResponse
listTypes(ListTypesRequest request)
Returns a list of all types within a data catalog.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for a given work request.ListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a (paginated) list of logs for a given work request.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.ObjectStatsResponse
objectStats(ObjectStatsRequest request)
Returns stats on objects by type in the repository.ParseConnectionResponse
parseConnection(ParseConnectionRequest request)
Parse data asset references through connections from this data asset.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.ProcessRecommendationResponse
processRecommendation(ProcessRecommendationRequest request)
Act on a recommendation.RecommendationsResponse
recommendations(RecommendationsRequest request)
Returns a list of recommendations for the given object and recommendation type.void
refreshClient()
Rebuild the backingHttpClient
.RemoveCatalogLockResponse
removeCatalogLock(RemoveCatalogLockRequest request)
Removes a lock from a Catalog resource.RemoveCatalogPrivateEndpointLockResponse
removeCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest request)
Removes a lock from a CatalogPrivateEndpoint resource.RemoveDataSelectorPatternsResponse
removeDataSelectorPatterns(RemoveDataSelectorPatternsRequest request)
Remove data selector pattern from the data asset.RemoveMetastoreLockResponse
removeMetastoreLock(RemoveMetastoreLockRequest request)
Removes a lock from a Metastore resource.SearchCriteriaResponse
searchCriteria(SearchCriteriaRequest request)
Returns a list of search results within a data catalog.void
setEndpoint(String endpoint)
void
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).void
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).SuggestMatchesResponse
suggestMatches(SuggestMatchesRequest request)
Returns a list of potential string matches for a given input string.SynchronousExportDataAssetResponse
synchronousExportDataAsset(SynchronousExportDataAssetRequest request)
Export technical objects from a Data AssetTestConnectionResponse
testConnection(TestConnectionRequest request)
Test the connection by connecting to the data asset using credentials in the metadata.UpdateAttributeResponse
updateAttribute(UpdateAttributeRequest request)
Updates a specific data asset attribute.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateCatalogResponse
updateCatalog(UpdateCatalogRequest request)
Updates the data catalog.UpdateCatalogPrivateEndpointResponse
updateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest request)
Updates the private reverse connection endpoint.UpdateConnectionResponse
updateConnection(UpdateConnectionRequest request)
Updates a specific connection of a data asset.UpdateCustomPropertyResponse
updateCustomProperty(UpdateCustomPropertyRequest request)
Updates a specific custom property identified by the given key.UpdateDataAssetResponse
updateDataAsset(UpdateDataAssetRequest request)
Updates a specific data asset identified by the given key.UpdateEntityResponse
updateEntity(UpdateEntityRequest request)
Updates a specific data entity.UpdateFolderResponse
updateFolder(UpdateFolderRequest request)
Updates a specific folder of a data asset.UpdateGlossaryResponse
updateGlossary(UpdateGlossaryRequest request)
Updates a specific glossary identified by the given key.UpdateJobResponse
updateJob(UpdateJobRequest request)
Updates a specific job identified by the given key.UpdateJobDefinitionResponse
updateJobDefinition(UpdateJobDefinitionRequest request)
Update a specific job definition identified by the given key.UpdateMetastoreResponse
updateMetastore(UpdateMetastoreRequest request)
Updates a metastore resource by identifier.UpdateNamespaceResponse
updateNamespace(UpdateNamespaceRequest request)
Updates a specific namespace identified by the given key.UpdatePatternResponse
updatePattern(UpdatePatternRequest request)
Updates a specific pattern identified by the given key.UpdateTermResponse
updateTerm(UpdateTermRequest request)
Updates a specific glossary term.UpdateTermRelationshipResponse
updateTermRelationship(UpdateTermRelationshipRequest request)
Updates a specific glossary term relationship.UploadCredentialsResponse
uploadCredentials(UploadCredentialsRequest request)
Upload connection credentails and metadata for this connection.void
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.UsersResponse
users(UsersRequest request)
Returns active users in the system.ValidateConnectionResponse
validateConnection(ValidateConnectionRequest request)
Validate connection by connecting to the data asset using credentials in metadata.ValidatePatternResponse
validatePattern(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 thebuilder
instead.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 thebuilder
instead.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 thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DataCatalogClient
@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DataCatalogClient
@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DataCatalogClient
@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
DataCatalogClient
@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
DataCatalogClient
@Deprecated public DataCatalogClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataCatalogClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
-DataCatalogClient.Builder.executorService
-
-
Method Detail
-
builder
public static DataCatalogClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DataCatalog
Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegion
in interfaceDataCatalog
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DataCatalog
Sets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion
.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)
and then callsetEndpoint
.- Specified by:
setRegion
in interfaceDataCatalog
- Parameters:
regionId
- The public region ID.
-
addCatalogLock
public AddCatalogLockResponse addCatalogLock(AddCatalogLockRequest request)
Description copied from interface:DataCatalog
Adds a lock to a Catalog resource.- Specified by:
addCatalogLock
in 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:DataCatalog
Adds a lock to a CatalogPrivateEndpoint resource.- Specified by:
addCatalogPrivateEndpointLock
in 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:DataCatalog
Add data selector pattern to the data asset.- Specified by:
addDataSelectorPatterns
in 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:DataCatalog
Adds a lock to a Metastore resource.- Specified by:
addMetastoreLock
in 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:DataCatalog
Associate the custom property for the given type- Specified by:
associateCustomProperty
in 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:DataCatalog
Export technical objects from a Data Asset in Excel format.Returns details about the job which actually performs the export.
- Specified by:
asynchronousExportDataAsset
in 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:DataCatalog
Exports the contents of a glossary in Excel format.Returns details about the job which actually performs the export.
- Specified by:
asynchronousExportGlossary
in 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:DataCatalog
Attaches 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:
attachCatalogPrivateEndpoint
in 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:DataCatalog
Moves a resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeCatalogCompartment
in 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:DataCatalog
Moves a resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeCatalogPrivateEndpointCompartment
in 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:DataCatalog
Moves a resource into a different compartment.When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.
- Specified by:
changeMetastoreCompartment
in 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:DataCatalog
Creates a new entity attribute.- Specified by:
createAttribute
in 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:DataCatalog
Creates a new entity attribute tag.- Specified by:
createAttributeTag
in 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:DataCatalog
Creates a new data catalog instance that includes a console and an API URL for managing metadata operations.For more information, please see the documentation.
- Specified by:
createCatalog
in 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:DataCatalog
Create a new private reverse connection endpoint.- Specified by:
createCatalogPrivateEndpoint
in 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:DataCatalog
Creates a new connection.- Specified by:
createConnection
in 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:DataCatalog
Create a new Custom Property- Specified by:
createCustomProperty
in 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:DataCatalog
Create a new data asset.- Specified by:
createDataAsset
in 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:DataCatalog
Creates a new data asset tag.- Specified by:
createDataAssetTag
in 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:DataCatalog
Creates a new data entity.- Specified by:
createEntity
in 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:DataCatalog
Creates a new entity tag.- Specified by:
createEntityTag
in 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:DataCatalog
Creates a new folder.- Specified by:
createFolder
in 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:DataCatalog
Creates a new folder tag.- Specified by:
createFolderTag
in 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:DataCatalog
Creates a new glossary.- Specified by:
createGlossary
in 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:DataCatalog
Creates a new job.- Specified by:
createJob
in 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:DataCatalog
Creates a new job definition.- Specified by:
createJobDefinition
in 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:DataCatalog
Creates a new job execution.- Specified by:
createJobExecution
in 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:DataCatalog
Creates a new metastore.- Specified by:
createMetastore
in 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:DataCatalog
Create a new Namespace to be used by a custom property- Specified by:
createNamespace
in 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:DataCatalog
Create a new pattern.- Specified by:
createPattern
in 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:DataCatalog
Create a new term within a glossary.- Specified by:
createTerm
in 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:DataCatalog
Creates a new term relationship for this term within a glossary.- Specified by:
createTermRelationship
in 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:DataCatalog
Deletes a specific entity attribute.- Specified by:
deleteAttribute
in 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:DataCatalog
Deletes a specific entity attribute tag.- Specified by:
deleteAttributeTag
in 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:DataCatalog
Deletes a data catalog resource by identifier.- Specified by:
deleteCatalog
in 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:DataCatalog
Deletes a private reverse connection endpoint by identifier.- Specified by:
deleteCatalogPrivateEndpoint
in 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:DataCatalog
Deletes a specific connection of a data asset.- Specified by:
deleteConnection
in 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:DataCatalog
Deletes a specific custom property identified by it’s key.- Specified by:
deleteCustomProperty
in 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:DataCatalog
Deletes a specific data asset identified by it’s key.- Specified by:
deleteDataAsset
in 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:DataCatalog
Deletes a specific data asset tag.- Specified by:
deleteDataAssetTag
in 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:DataCatalog
Deletes a specific data entity.- Specified by:
deleteEntity
in 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:DataCatalog
Deletes a specific entity tag.- Specified by:
deleteEntityTag
in 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:DataCatalog
Deletes a specific folder of a data asset identified by it’s key.- Specified by:
deleteFolder
in 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:DataCatalog
Deletes a specific folder tag.- Specified by:
deleteFolderTag
in 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:DataCatalog
Deletes a specific glossary identified by it’s key.- Specified by:
deleteGlossary
in 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:DataCatalog
Deletes a specific job identified by it’s key.- Specified by:
deleteJob
in 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:DataCatalog
Deletes a specific job definition identified by it’s key.- Specified by:
deleteJobDefinition
in 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:DataCatalog
Deletes a metastore resource by identifier.- Specified by:
deleteMetastore
in 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:DataCatalog
Deletes a specific Namespace identified by it’s key.- Specified by:
deleteNamespace
in 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:DataCatalog
Deletes a specific pattern identified by it’s key.- Specified by:
deletePattern
in 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:DataCatalog
Deletes a specific glossary term.- Specified by:
deleteTerm
in 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:DataCatalog
Deletes a specific glossary term relationship.- Specified by:
deleteTermRelationship
in 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:DataCatalog
Detaches 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:
detachCatalogPrivateEndpoint
in 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:DataCatalog
Remove the custom property for the given type- Specified by:
disassociateCustomProperty
in 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:DataCatalog
Returns the fully expanded tree hierarchy of parent and child terms in this glossary.- Specified by:
expandTreeForGlossary
in 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:DataCatalog
Export the glossary and the terms and return the exported glossary as csv or json.- Specified by:
exportGlossary
in 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:DataCatalog
Returns lineage for a given entity object.- Specified by:
fetchEntityLineage
in 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:DataCatalog
Gets a specific entity attribute by key.- Specified by:
getAttribute
in 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:DataCatalog
Gets a specific entity attribute tag by key.- Specified by:
getAttributeTag
in 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:DataCatalog
Gets a data catalog by identifier.- Specified by:
getCatalog
in 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:DataCatalog
Gets a specific private reverse connection by identifier.- Specified by:
getCatalogPrivateEndpoint
in 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:DataCatalog
Gets a specific data asset connection by key.- Specified by:
getConnection
in 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:DataCatalog
Gets a specific custom property for the given key within a data catalog.- Specified by:
getCustomProperty
in 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:DataCatalog
Gets a specific data asset for the given key within a data catalog.- Specified by:
getDataAsset
in 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:DataCatalog
Gets a specific data asset tag by key.- Specified by:
getDataAssetTag
in 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:DataCatalog
Gets a specific data entity by key for a data asset.- Specified by:
getEntity
in 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:DataCatalog
Gets a specific entity tag by key.- Specified by:
getEntityTag
in 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:DataCatalog
Gets a specific data asset folder by key.- Specified by:
getFolder
in 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:DataCatalog
Gets a specific folder tag by key.- Specified by:
getFolderTag
in 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:DataCatalog
Gets a specific glossary by key within a data catalog.- Specified by:
getGlossary
in 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:DataCatalog
Gets a specific job by key within a data catalog.- Specified by:
getJob
in 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:DataCatalog
Gets a specific job definition by key within a data catalog.- Specified by:
getJobDefinition
in 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:DataCatalog
Gets a specific job execution by key.- Specified by:
getJobExecution
in 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:DataCatalog
Gets a specific job log by key.- Specified by:
getJobLog
in 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:DataCatalog
Gets a specific job metric by key.- Specified by:
getJobMetrics
in 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:DataCatalog
Gets a metastore by identifier.- Specified by:
getMetastore
in 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:DataCatalog
Gets a specific namespace for the given key within a data catalog.- Specified by:
getNamespace
in 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:DataCatalog
Gets a specific pattern for the given key within a data catalog.- Specified by:
getPattern
in 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:DataCatalog
Gets a specific glossary term by key.- Specified by:
getTerm
in 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:DataCatalog
Gets a specific glossary term relationship by key.- Specified by:
getTermRelationship
in 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:DataCatalog
Gets a specific type by key within a data catalog.- Specified by:
getType
in 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:DataCatalog
Gets the status of the work request with the given OCID.- Specified by:
getWorkRequest
in 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:DataCatalog
Import new connection for this data asset.- Specified by:
importConnection
in 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:DataCatalog
Import technical objects to a Data Asset- Specified by:
importDataAsset
in 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:DataCatalog
Import the glossary and the terms from csv or json files and return the imported glossary resource.- Specified by:
importGlossary
in 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:DataCatalog
Imports lineage metadata.Returns details about the job that performs the import.
- Specified by:
importLineage
in 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:DataCatalog
List the physical entities aggregated by this logical entity.- Specified by:
listAggregatedPhysicalEntities
in 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:DataCatalog
Returns a list of all tags for an entity attribute.- Specified by:
listAttributeTags
in 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:DataCatalog
Returns a list of all attributes of an data entity.- Specified by:
listAttributes
in 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:DataCatalog
Returns a list of all the catalog private endpoints in the specified compartment.- Specified by:
listCatalogPrivateEndpoints
in 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:DataCatalog
Returns a list of all the data catalogs in the specified compartment.- Specified by:
listCatalogs
in 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:DataCatalog
Returns a list of all Connections for a data asset.- Specified by:
listConnections
in 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:DataCatalog
Returns a list of custom properties within a data catalog.- Specified by:
listCustomProperties
in 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:DataCatalog
Returns a list of all tags for a data asset.- Specified by:
listDataAssetTags
in 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:DataCatalog
Returns a list of data assets within a data catalog.- Specified by:
listDataAssets
in 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:DataCatalog
List logical entities derived from this pattern.- Specified by:
listDerivedLogicalEntities
in 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:DataCatalog
Returns a list of all entities of a data asset.- Specified by:
listEntities
in 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:DataCatalog
Returns a list of all tags for a data entity.- Specified by:
listEntityTags
in 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:DataCatalog
Returns a list of all tags for a folder.- Specified by:
listFolderTags
in 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:DataCatalog
Returns a list of all folders.- Specified by:
listFolders
in 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:DataCatalog
Returns a list of all glossaries within a data catalog.- Specified by:
listGlossaries
in 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:DataCatalog
Returns a list of job definitions within a data catalog.- Specified by:
listJobDefinitions
in 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:DataCatalog
Returns a list of job executions for a job.- Specified by:
listJobExecutions
in 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:DataCatalog
Returns a list of job logs.- Specified by:
listJobLogs
in 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:DataCatalog
Returns a list of job metrics.- Specified by:
listJobMetrics
in 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:DataCatalog
Returns a list of jobs within a data catalog.- Specified by:
listJobs
in 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:DataCatalog
Returns a list of all metastores in the specified compartment.- Specified by:
listMetastores
in 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:DataCatalog
Returns a list of namespaces within a data catalog.- Specified by:
listNamespaces
in 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:DataCatalog
Returns a list of patterns within a data catalog.- Specified by:
listPatterns
in 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:DataCatalog
Returns a list of all rules of a data entity.- Specified by:
listRules
in 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:DataCatalog
Returns a list of all user created tags in the system.- Specified by:
listTags
in 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:DataCatalog
Returns a list of all term relationships within a glossary.- Specified by:
listTermRelationships
in 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:DataCatalog
Returns a list of all terms within a glossary.- Specified by:
listTerms
in 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:DataCatalog
Returns a list of all types within a data catalog.- Specified by:
listTypes
in 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:DataCatalog
Returns a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrors
in 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:DataCatalog
Returns a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogs
in 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:DataCatalog
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in 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:DataCatalog
Returns stats on objects by type in the repository.- Specified by:
objectStats
in 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:DataCatalog
Parse data asset references through connections from this data asset.- Specified by:
parseConnection
in 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:DataCatalog
Act on a recommendation.A recommendation can be accepted or rejected. For example, if a recommendation of type LINK_GLOSSARY_TERM is accepted, the system will link the source object (e.g. an attribute) to a target glossary term.
- Specified by:
processRecommendation
in 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:DataCatalog
Returns a list of recommendations for the given object and recommendation type.By default, it will return inferred recommendations for review. The optional query param ‘RecommendationStatus’ can be set, to return only recommendations having that status.
- Specified by:
recommendations
in 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:DataCatalog
Removes a lock from a Catalog resource.- Specified by:
removeCatalogLock
in 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:DataCatalog
Removes a lock from a CatalogPrivateEndpoint resource.- Specified by:
removeCatalogPrivateEndpointLock
in 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:DataCatalog
Remove data selector pattern from the data asset.- Specified by:
removeDataSelectorPatterns
in 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:DataCatalog
Removes a lock from a Metastore resource.- Specified by:
removeMetastoreLock
in 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:DataCatalog
Returns a list of search results within a data catalog.- Specified by:
searchCriteria
in 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:DataCatalog
Returns a list of potential string matches for a given input string.- Specified by:
suggestMatches
in 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:DataCatalog
Export technical objects from a Data Asset- Specified by:
synchronousExportDataAsset
in 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:DataCatalog
Test the connection by connecting to the data asset using credentials in the metadata.- Specified by:
testConnection
in 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:DataCatalog
Updates a specific data asset attribute.- Specified by:
updateAttribute
in 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:DataCatalog
Updates the data catalog.- Specified by:
updateCatalog
in 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:DataCatalog
Updates the private reverse connection endpoint.- Specified by:
updateCatalogPrivateEndpoint
in 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:DataCatalog
Updates a specific connection of a data asset.- Specified by:
updateConnection
in 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:DataCatalog
Updates a specific custom property identified by the given key.- Specified by:
updateCustomProperty
in 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:DataCatalog
Updates a specific data asset identified by the given key.- Specified by:
updateDataAsset
in 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:DataCatalog
Updates a specific data entity.- Specified by:
updateEntity
in 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:DataCatalog
Updates a specific folder of a data asset.- Specified by:
updateFolder
in 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:DataCatalog
Updates a specific glossary identified by the given key.- Specified by:
updateGlossary
in 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:DataCatalog
Updates a specific job identified by the given key.- Specified by:
updateJob
in 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:DataCatalog
Update a specific job definition identified by the given key.- Specified by:
updateJobDefinition
in 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:DataCatalog
Updates a metastore resource by identifier.- Specified by:
updateMetastore
in 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:DataCatalog
Updates a specific namespace identified by the given key.- Specified by:
updateNamespace
in 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:DataCatalog
Updates a specific pattern identified by the given key.- Specified by:
updatePattern
in 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:DataCatalog
Updates a specific glossary term.- Specified by:
updateTerm
in 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:DataCatalog
Updates a specific glossary term relationship.- Specified by:
updateTermRelationship
in 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:DataCatalog
Upload connection credentails and metadata for this connection.- Specified by:
uploadCredentials
in 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:DataCatalog
Returns active users in the system.- Specified by:
users
in 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:DataCatalog
Validate connection by connecting to the data asset using credentials in metadata.- Specified by:
validateConnection
in 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:DataCatalog
Validate pattern by deriving file groups representing logical entities using the expression- Specified by:
validatePattern
in 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:DataCatalog
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDataCatalog
- Returns:
- The service waiters.
-
getPaginators
public DataCatalogPaginators getPaginators()
Description copied from interface:DataCatalog
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginators
in 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
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-