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