Class DataCatalogClient
Service client instance for DataCatalog.
Implements
Inherited Members
Namespace: Oci.DatacatalogService
Assembly: OCI.DotNetSDK.Datacatalog.dll
Syntax
public class DataCatalogClient : RegionalClientBase, IDisposable
Constructors
DataCatalogClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public DataCatalogClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public DataCatalogPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DataCatalogPaginators |
Waiters
Declaration
public DataCatalogWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DataCatalogWaiters |
Methods
AddCatalogLock(AddCatalogLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a lock to a Catalog resource.
Declaration
public Task<AddCatalogLockResponse> AddCatalogLock(AddCatalogLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddCatalogLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddCatalogLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddCatalogLock API.
AddCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a lock to a CatalogPrivateEndpoint resource.
Declaration
public Task<AddCatalogPrivateEndpointLockResponse> AddCatalogPrivateEndpointLock(AddCatalogPrivateEndpointLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddCatalogPrivateEndpointLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddCatalogPrivateEndpointLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddCatalogPrivateEndpointLock API.
AddDataSelectorPatterns(AddDataSelectorPatternsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Add data selector pattern to the data asset.
Declaration
public Task<AddDataSelectorPatternsResponse> AddDataSelectorPatterns(AddDataSelectorPatternsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddDataSelectorPatternsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddDataSelectorPatternsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddDataSelectorPatterns API.
AddMetastoreLock(AddMetastoreLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Adds a lock to a Metastore resource.
Declaration
public Task<AddMetastoreLockResponse> AddMetastoreLock(AddMetastoreLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AddMetastoreLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AddMetastoreLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AddMetastoreLock API.
AssociateCustomProperty(AssociateCustomPropertyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Associate the custom property for the given type
Declaration
public Task<AssociateCustomPropertyResponse> AssociateCustomProperty(AssociateCustomPropertyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AssociateCustomPropertyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AssociateCustomPropertyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AssociateCustomProperty API.
AsynchronousExportDataAsset(AsynchronousExportDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Export technical objects from a Data Asset in Excel format. Returns details about the job which actually performs the export.
Declaration
public Task<AsynchronousExportDataAssetResponse> AsynchronousExportDataAsset(AsynchronousExportDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AsynchronousExportDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AsynchronousExportDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AsynchronousExportDataAsset API.
AsynchronousExportGlossary(AsynchronousExportGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Exports the contents of a glossary in Excel format. Returns details about the job which actually performs the export.
Declaration
public Task<AsynchronousExportGlossaryResponse> AsynchronousExportGlossary(AsynchronousExportGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AsynchronousExportGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AsynchronousExportGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AsynchronousExportGlossary API.
AttachCatalogPrivateEndpoint(AttachCatalogPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Attaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.
Declaration
public Task<AttachCatalogPrivateEndpointResponse> AttachCatalogPrivateEndpoint(AttachCatalogPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachCatalogPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<AttachCatalogPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachCatalogPrivateEndpoint API.
ChangeCatalogCompartment(ChangeCatalogCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
Declaration
public Task<ChangeCatalogCompartmentResponse> ChangeCatalogCompartment(ChangeCatalogCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCatalogCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCatalogCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCatalogCompartment API.
ChangeCatalogPrivateEndpointCompartment(ChangeCatalogPrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
Declaration
public Task<ChangeCatalogPrivateEndpointCompartmentResponse> ChangeCatalogPrivateEndpointCompartment(ChangeCatalogPrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeCatalogPrivateEndpointCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeCatalogPrivateEndpointCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeCatalogPrivateEndpointCompartment API.
ChangeMetastoreCompartment(ChangeMetastoreCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
Declaration
public Task<ChangeMetastoreCompartmentResponse> ChangeMetastoreCompartment(ChangeMetastoreCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeMetastoreCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeMetastoreCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeMetastoreCompartment API.
CreateAttribute(CreateAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new entity attribute.
Declaration
public Task<CreateAttributeResponse> CreateAttribute(CreateAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAttributeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAttribute API.
CreateAttributeTag(CreateAttributeTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new entity attribute tag.
Declaration
public Task<CreateAttributeTagResponse> CreateAttributeTag(CreateAttributeTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAttributeTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAttributeTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAttributeTag API.
CreateCatalog(CreateCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<CreateCatalogResponse> CreateCatalog(CreateCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCatalog API.
CreateCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new private reverse connection endpoint.
Declaration
public Task<CreateCatalogPrivateEndpointResponse> CreateCatalogPrivateEndpoint(CreateCatalogPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCatalogPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCatalogPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCatalogPrivateEndpoint API.
CreateConnection(CreateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new connection.
Declaration
public Task<CreateConnectionResponse> CreateConnection(CreateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateConnection API.
CreateCustomProperty(CreateCustomPropertyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new Custom Property
Declaration
public Task<CreateCustomPropertyResponse> CreateCustomProperty(CreateCustomPropertyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateCustomPropertyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateCustomPropertyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCustomProperty API.
CreateDataAsset(CreateDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new data asset.
Declaration
public Task<CreateDataAssetResponse> CreateDataAsset(CreateDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDataAsset API.
CreateDataAssetTag(CreateDataAssetTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new data asset tag.
Declaration
public Task<CreateDataAssetTagResponse> CreateDataAssetTag(CreateDataAssetTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDataAssetTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDataAssetTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDataAssetTag API.
CreateEntity(CreateEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new data entity.
Declaration
public Task<CreateEntityResponse> CreateEntity(CreateEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateEntity API.
CreateEntityTag(CreateEntityTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new entity tag.
Declaration
public Task<CreateEntityTagResponse> CreateEntityTag(CreateEntityTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateEntityTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateEntityTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateEntityTag API.
CreateFolder(CreateFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new folder.
Declaration
public Task<CreateFolderResponse> CreateFolder(CreateFolderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateFolderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateFolderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateFolder API.
CreateFolderTag(CreateFolderTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new folder tag.
Declaration
public Task<CreateFolderTagResponse> CreateFolderTag(CreateFolderTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateFolderTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateFolderTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateFolderTag API.
CreateGlossary(CreateGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new glossary.
Declaration
public Task<CreateGlossaryResponse> CreateGlossary(CreateGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateGlossary API.
CreateJob(CreateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new job.
Declaration
public Task<CreateJobResponse> CreateJob(CreateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateJob API.
CreateJobDefinition(CreateJobDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new job definition.
Declaration
public Task<CreateJobDefinitionResponse> CreateJobDefinition(CreateJobDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateJobDefinitionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateJobDefinitionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateJobDefinition API.
CreateJobExecution(CreateJobExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new job execution.
Declaration
public Task<CreateJobExecutionResponse> CreateJobExecution(CreateJobExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateJobExecutionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateJobExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateJobExecution API.
CreateMetastore(CreateMetastoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new metastore.
Declaration
public Task<CreateMetastoreResponse> CreateMetastore(CreateMetastoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateMetastoreRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateMetastoreResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateMetastore API.
CreateNamespace(CreateNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new Namespace to be used by a custom property
Declaration
public Task<CreateNamespaceResponse> CreateNamespace(CreateNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateNamespace API.
CreatePattern(CreatePatternRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new pattern.
Declaration
public Task<CreatePatternResponse> CreatePattern(CreatePatternRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePatternRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePatternResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePattern API.
CreateTerm(CreateTermRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new term within a glossary.
Declaration
public Task<CreateTermResponse> CreateTerm(CreateTermRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTermRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTermResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTerm API.
CreateTermRelationship(CreateTermRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new term relationship for this term within a glossary.
Declaration
public Task<CreateTermRelationshipResponse> CreateTermRelationship(CreateTermRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTermRelationshipRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTermRelationshipResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTermRelationship API.
DeleteAttribute(DeleteAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific entity attribute.
Declaration
public Task<DeleteAttributeResponse> DeleteAttribute(DeleteAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAttributeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAttribute API.
DeleteAttributeTag(DeleteAttributeTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific entity attribute tag.
Declaration
public Task<DeleteAttributeTagResponse> DeleteAttributeTag(DeleteAttributeTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAttributeTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAttributeTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAttributeTag API.
DeleteCatalog(DeleteCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a data catalog resource by identifier.
Declaration
public Task<DeleteCatalogResponse> DeleteCatalog(DeleteCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCatalog API.
DeleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a private reverse connection endpoint by identifier.
Declaration
public Task<DeleteCatalogPrivateEndpointResponse> DeleteCatalogPrivateEndpoint(DeleteCatalogPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCatalogPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCatalogPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCatalogPrivateEndpoint API.
DeleteConnection(DeleteConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific connection of a data asset.
Declaration
public Task<DeleteConnectionResponse> DeleteConnection(DeleteConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteConnection API.
DeleteCustomProperty(DeleteCustomPropertyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific custom property identified by it's key.
Declaration
public Task<DeleteCustomPropertyResponse> DeleteCustomProperty(DeleteCustomPropertyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteCustomPropertyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteCustomPropertyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCustomProperty API.
DeleteDataAsset(DeleteDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific data asset identified by it's key.
Declaration
public Task<DeleteDataAssetResponse> DeleteDataAsset(DeleteDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDataAsset API.
DeleteDataAssetTag(DeleteDataAssetTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific data asset tag.
Declaration
public Task<DeleteDataAssetTagResponse> DeleteDataAssetTag(DeleteDataAssetTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDataAssetTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDataAssetTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDataAssetTag API.
DeleteEntity(DeleteEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific data entity.
Declaration
public Task<DeleteEntityResponse> DeleteEntity(DeleteEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteEntity API.
DeleteEntityTag(DeleteEntityTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific entity tag.
Declaration
public Task<DeleteEntityTagResponse> DeleteEntityTag(DeleteEntityTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteEntityTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteEntityTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteEntityTag API.
DeleteFolder(DeleteFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific folder of a data asset identified by it's key.
Declaration
public Task<DeleteFolderResponse> DeleteFolder(DeleteFolderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteFolderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteFolderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteFolder API.
DeleteFolderTag(DeleteFolderTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific folder tag.
Declaration
public Task<DeleteFolderTagResponse> DeleteFolderTag(DeleteFolderTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteFolderTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteFolderTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteFolderTag API.
DeleteGlossary(DeleteGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific glossary identified by it's key.
Declaration
public Task<DeleteGlossaryResponse> DeleteGlossary(DeleteGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteGlossary API.
DeleteJob(DeleteJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific job identified by it's key.
Declaration
public Task<DeleteJobResponse> DeleteJob(DeleteJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteJob API.
DeleteJobDefinition(DeleteJobDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific job definition identified by it's key.
Declaration
public Task<DeleteJobDefinitionResponse> DeleteJobDefinition(DeleteJobDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteJobDefinitionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteJobDefinitionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteJobDefinition API.
DeleteMetastore(DeleteMetastoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a metastore resource by identifier.
Declaration
public Task<DeleteMetastoreResponse> DeleteMetastore(DeleteMetastoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteMetastoreRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteMetastoreResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteMetastore API.
DeleteNamespace(DeleteNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific Namespace identified by it's key.
Declaration
public Task<DeleteNamespaceResponse> DeleteNamespace(DeleteNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteNamespace API.
DeletePattern(DeletePatternRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific pattern identified by it's key.
Declaration
public Task<DeletePatternResponse> DeletePattern(DeletePatternRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePatternRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePatternResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePattern API.
DeleteTerm(DeleteTermRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific glossary term.
Declaration
public Task<DeleteTermResponse> DeleteTerm(DeleteTermRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTermRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTermResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTerm API.
DeleteTermRelationship(DeleteTermRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specific glossary term relationship.
Declaration
public Task<DeleteTermRelationshipResponse> DeleteTermRelationship(DeleteTermRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTermRelationshipRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTermRelationshipResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTermRelationship API.
DetachCatalogPrivateEndpoint(DetachCatalogPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Detaches a private reverse connection endpoint resource to a data catalog resource. When provided, 'If-Match' is checked against 'ETag' values of the resource.
Declaration
public Task<DetachCatalogPrivateEndpointResponse> DetachCatalogPrivateEndpoint(DetachCatalogPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachCatalogPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetachCatalogPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachCatalogPrivateEndpoint API.
DisassociateCustomProperty(DisassociateCustomPropertyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove the custom property for the given type
Declaration
public Task<DisassociateCustomPropertyResponse> DisassociateCustomProperty(DisassociateCustomPropertyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DisassociateCustomPropertyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DisassociateCustomPropertyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisassociateCustomProperty API.
ExpandTreeForGlossary(ExpandTreeForGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the fully expanded tree hierarchy of parent and child terms in this glossary.
Declaration
public Task<ExpandTreeForGlossaryResponse> ExpandTreeForGlossary(ExpandTreeForGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExpandTreeForGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExpandTreeForGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExpandTreeForGlossary API.
ExportGlossary(ExportGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Export the glossary and the terms and return the exported glossary as csv or json.
Declaration
public Task<ExportGlossaryResponse> ExportGlossary(ExportGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExportGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExportGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExportGlossary API.
FetchEntityLineage(FetchEntityLineageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns lineage for a given entity object.
Declaration
public Task<FetchEntityLineageResponse> FetchEntityLineage(FetchEntityLineageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
FetchEntityLineageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<FetchEntityLineageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use FetchEntityLineage API.
GetAttribute(GetAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific entity attribute by key.
Declaration
public Task<GetAttributeResponse> GetAttribute(GetAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAttributeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAttribute API.
GetAttributeTag(GetAttributeTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific entity attribute tag by key.
Declaration
public Task<GetAttributeTagResponse> GetAttributeTag(GetAttributeTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAttributeTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAttributeTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAttributeTag API.
GetCatalog(GetCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a data catalog by identifier.
Declaration
public Task<GetCatalogResponse> GetCatalog(GetCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCatalog API.
GetCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific private reverse connection by identifier.
Declaration
public Task<GetCatalogPrivateEndpointResponse> GetCatalogPrivateEndpoint(GetCatalogPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCatalogPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCatalogPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCatalogPrivateEndpoint API.
GetConnection(GetConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific data asset connection by key.
Declaration
public Task<GetConnectionResponse> GetConnection(GetConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetConnection API.
GetCustomProperty(GetCustomPropertyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific custom property for the given key within a data catalog.
Declaration
public Task<GetCustomPropertyResponse> GetCustomProperty(GetCustomPropertyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCustomPropertyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetCustomPropertyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCustomProperty API.
GetDataAsset(GetDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific data asset for the given key within a data catalog.
Declaration
public Task<GetDataAssetResponse> GetDataAsset(GetDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDataAsset API.
GetDataAssetTag(GetDataAssetTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific data asset tag by key.
Declaration
public Task<GetDataAssetTagResponse> GetDataAssetTag(GetDataAssetTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDataAssetTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDataAssetTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDataAssetTag API.
GetEntity(GetEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific data entity by key for a data asset.
Declaration
public Task<GetEntityResponse> GetEntity(GetEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetEntity API.
GetEntityTag(GetEntityTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific entity tag by key.
Declaration
public Task<GetEntityTagResponse> GetEntityTag(GetEntityTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetEntityTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetEntityTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetEntityTag API.
GetFolder(GetFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific data asset folder by key.
Declaration
public Task<GetFolderResponse> GetFolder(GetFolderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFolderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetFolderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetFolder API.
GetFolderTag(GetFolderTagRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific folder tag by key.
Declaration
public Task<GetFolderTagResponse> GetFolderTag(GetFolderTagRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetFolderTagRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetFolderTagResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetFolderTag API.
GetGlossary(GetGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific glossary by key within a data catalog.
Declaration
public Task<GetGlossaryResponse> GetGlossary(GetGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetGlossary API.
GetJob(GetJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific job by key within a data catalog.
Declaration
public Task<GetJobResponse> GetJob(GetJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJob API.
GetJobDefinition(GetJobDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific job definition by key within a data catalog.
Declaration
public Task<GetJobDefinitionResponse> GetJobDefinition(GetJobDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJobDefinitionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJobDefinitionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJobDefinition API.
GetJobExecution(GetJobExecutionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific job execution by key.
Declaration
public Task<GetJobExecutionResponse> GetJobExecution(GetJobExecutionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJobExecutionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJobExecutionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJobExecution API.
GetJobLog(GetJobLogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific job log by key.
Declaration
public Task<GetJobLogResponse> GetJobLog(GetJobLogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJobLogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJobLogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJobLog API.
GetJobMetrics(GetJobMetricsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific job metric by key.
Declaration
public Task<GetJobMetricsResponse> GetJobMetrics(GetJobMetricsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJobMetricsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJobMetricsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJobMetrics API.
GetMetastore(GetMetastoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a metastore by identifier.
Declaration
public Task<GetMetastoreResponse> GetMetastore(GetMetastoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetMetastoreRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetMetastoreResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetMetastore API.
GetNamespace(GetNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific namespace for the given key within a data catalog.
Declaration
public Task<GetNamespaceResponse> GetNamespace(GetNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetNamespace API.
GetPattern(GetPatternRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific pattern for the given key within a data catalog.
Declaration
public Task<GetPatternResponse> GetPattern(GetPatternRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPatternRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPatternResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPattern API.
GetTerm(GetTermRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific glossary term by key.
Declaration
public Task<GetTermResponse> GetTerm(GetTermRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTermRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTermResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTerm API.
GetTermRelationship(GetTermRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific glossary term relationship by key.
Declaration
public Task<GetTermRelationshipResponse> GetTermRelationship(GetTermRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTermRelationshipRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTermRelationshipResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTermRelationship API.
GetType(GetTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a specific type by key within a data catalog.
Declaration
public Task<GetTypeResponse> GetType(GetTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetType API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the work request with the given OCID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ImportConnection(ImportConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Import new connection for this data asset.
Declaration
public Task<ImportConnectionResponse> ImportConnection(ImportConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportConnection API.
ImportDataAsset(ImportDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Import technical objects to a Data Asset
Declaration
public Task<ImportDataAssetResponse> ImportDataAsset(ImportDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportDataAsset API.
ImportGlossary(ImportGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Import the glossary and the terms from csv or json files and return the imported glossary resource.
Declaration
public Task<ImportGlossaryResponse> ImportGlossary(ImportGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportGlossary API.
ImportLineage(ImportLineageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Imports lineage metadata. Returns details about the job that performs the import.
Declaration
public Task<ImportLineageResponse> ImportLineage(ImportLineageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportLineageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportLineageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportLineage API.
ListAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List the physical entities aggregated by this logical entity.
Declaration
public Task<ListAggregatedPhysicalEntitiesResponse> ListAggregatedPhysicalEntities(ListAggregatedPhysicalEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAggregatedPhysicalEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAggregatedPhysicalEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAggregatedPhysicalEntities API.
ListAttributeTags(ListAttributeTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all tags for an entity attribute.
Declaration
public Task<ListAttributeTagsResponse> ListAttributeTags(ListAttributeTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAttributeTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAttributeTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAttributeTags API.
ListAttributes(ListAttributesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all attributes of an data entity.
Declaration
public Task<ListAttributesResponse> ListAttributes(ListAttributesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAttributesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAttributesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAttributes API.
ListCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all the catalog private endpoints in the specified compartment.
Declaration
public Task<ListCatalogPrivateEndpointsResponse> ListCatalogPrivateEndpoints(ListCatalogPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCatalogPrivateEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCatalogPrivateEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCatalogPrivateEndpoints API.
ListCatalogs(ListCatalogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all the data catalogs in the specified compartment.
Declaration
public Task<ListCatalogsResponse> ListCatalogs(ListCatalogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCatalogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCatalogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCatalogs API.
ListConnections(ListConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all Connections for a data asset.
Declaration
public Task<ListConnectionsResponse> ListConnections(ListConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListConnectionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListConnectionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListConnections API.
ListCustomProperties(ListCustomPropertiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of custom properties within a data catalog.
Declaration
public Task<ListCustomPropertiesResponse> ListCustomProperties(ListCustomPropertiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCustomPropertiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListCustomPropertiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCustomProperties API.
ListDataAssetTags(ListDataAssetTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all tags for a data asset.
Declaration
public Task<ListDataAssetTagsResponse> ListDataAssetTags(ListDataAssetTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDataAssetTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDataAssetTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDataAssetTags API.
ListDataAssets(ListDataAssetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of data assets within a data catalog.
Declaration
public Task<ListDataAssetsResponse> ListDataAssets(ListDataAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDataAssetsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDataAssetsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDataAssets API.
ListDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
List logical entities derived from this pattern.
Declaration
public Task<ListDerivedLogicalEntitiesResponse> ListDerivedLogicalEntities(ListDerivedLogicalEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDerivedLogicalEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDerivedLogicalEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDerivedLogicalEntities API.
ListEntities(ListEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all entities of a data asset.
Declaration
public Task<ListEntitiesResponse> ListEntities(ListEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEntities API.
ListEntityTags(ListEntityTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all tags for a data entity.
Declaration
public Task<ListEntityTagsResponse> ListEntityTags(ListEntityTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEntityTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEntityTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEntityTags API.
ListFolderTags(ListFolderTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all tags for a folder.
Declaration
public Task<ListFolderTagsResponse> ListFolderTags(ListFolderTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListFolderTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListFolderTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListFolderTags API.
ListFolders(ListFoldersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all folders.
Declaration
public Task<ListFoldersResponse> ListFolders(ListFoldersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListFoldersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListFoldersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListFolders API.
ListGlossaries(ListGlossariesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all glossaries within a data catalog.
Declaration
public Task<ListGlossariesResponse> ListGlossaries(ListGlossariesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListGlossariesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListGlossariesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListGlossaries API.
ListJobDefinitions(ListJobDefinitionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of job definitions within a data catalog.
Declaration
public Task<ListJobDefinitionsResponse> ListJobDefinitions(ListJobDefinitionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListJobDefinitionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListJobDefinitionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListJobDefinitions API.
ListJobExecutions(ListJobExecutionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of job executions for a job.
Declaration
public Task<ListJobExecutionsResponse> ListJobExecutions(ListJobExecutionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListJobExecutionsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListJobExecutionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListJobExecutions API.
ListJobLogs(ListJobLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of job logs.
Declaration
public Task<ListJobLogsResponse> ListJobLogs(ListJobLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListJobLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListJobLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListJobLogs API.
ListJobMetrics(ListJobMetricsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of job metrics.
Declaration
public Task<ListJobMetricsResponse> ListJobMetrics(ListJobMetricsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListJobMetricsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListJobMetricsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListJobMetrics API.
ListJobs(ListJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of jobs within a data catalog.
Declaration
public Task<ListJobsResponse> ListJobs(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListJobsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListJobsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListJobs API.
ListMetastores(ListMetastoresRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all metastores in the specified compartment.
Declaration
public Task<ListMetastoresResponse> ListMetastores(ListMetastoresRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListMetastoresRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListMetastoresResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListMetastores API.
ListNamespaces(ListNamespacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of namespaces within a data catalog.
Declaration
public Task<ListNamespacesResponse> ListNamespaces(ListNamespacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListNamespacesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListNamespacesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListNamespaces API.
ListPatterns(ListPatternsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of patterns within a data catalog.
Declaration
public Task<ListPatternsResponse> ListPatterns(ListPatternsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPatternsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPatternsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPatterns API.
ListRules(ListRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all rules of a data entity.
Declaration
public Task<ListRulesResponse> ListRules(ListRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRulesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRulesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRules API.
ListTags(ListTagsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all user created tags in the system.
Declaration
public Task<ListTagsResponse> ListTags(ListTagsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTagsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTagsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTags API.
ListTermRelationships(ListTermRelationshipsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all term relationships within a glossary.
Declaration
public Task<ListTermRelationshipsResponse> ListTermRelationships(ListTermRelationshipsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTermRelationshipsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTermRelationshipsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTermRelationships API.
ListTerms(ListTermsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all terms within a glossary.
Declaration
public Task<ListTermsResponse> ListTerms(ListTermsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTermsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTermsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTerms API.
ListTypes(ListTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all types within a data catalog.
Declaration
public Task<ListTypesResponse> ListTypes(ListTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTypes API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of errors for a given work request.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of logs for a given work request.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
ObjectStats(ObjectStatsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns stats on objects by type in the repository.
Declaration
public Task<ObjectStatsResponse> ObjectStats(ObjectStatsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ObjectStatsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ObjectStatsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ObjectStats API.
ParseConnection(ParseConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Parse data asset references through connections from this data asset.
Declaration
public Task<ParseConnectionResponse> ParseConnection(ParseConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ParseConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ParseConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ParseConnection API.
ProcessRecommendation(ProcessRecommendationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ProcessRecommendationResponse> ProcessRecommendation(ProcessRecommendationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ProcessRecommendationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ProcessRecommendationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ProcessRecommendation API.
Recommendations(RecommendationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<RecommendationsResponse> Recommendations(RecommendationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RecommendationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RecommendationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Recommendations API.
RemoveCatalogLock(RemoveCatalogLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a lock from a Catalog resource.
Declaration
public Task<RemoveCatalogLockResponse> RemoveCatalogLock(RemoveCatalogLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveCatalogLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveCatalogLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveCatalogLock API.
RemoveCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a lock from a CatalogPrivateEndpoint resource.
Declaration
public Task<RemoveCatalogPrivateEndpointLockResponse> RemoveCatalogPrivateEndpointLock(RemoveCatalogPrivateEndpointLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveCatalogPrivateEndpointLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveCatalogPrivateEndpointLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveCatalogPrivateEndpointLock API.
RemoveDataSelectorPatterns(RemoveDataSelectorPatternsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Remove data selector pattern from the data asset.
Declaration
public Task<RemoveDataSelectorPatternsResponse> RemoveDataSelectorPatterns(RemoveDataSelectorPatternsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveDataSelectorPatternsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveDataSelectorPatternsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveDataSelectorPatterns API.
RemoveMetastoreLock(RemoveMetastoreLockRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Removes a lock from a Metastore resource.
Declaration
public Task<RemoveMetastoreLockResponse> RemoveMetastoreLock(RemoveMetastoreLockRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RemoveMetastoreLockRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RemoveMetastoreLockResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RemoveMetastoreLock API.
SearchCriteria(SearchCriteriaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of search results within a data catalog.
Declaration
public Task<SearchCriteriaResponse> SearchCriteria(SearchCriteriaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SearchCriteriaRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SearchCriteriaResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SearchCriteria API.
SuggestMatches(SuggestMatchesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of potential string matches for a given input string.
Declaration
public Task<SuggestMatchesResponse> SuggestMatches(SuggestMatchesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SuggestMatchesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SuggestMatchesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SuggestMatches API.
SynchronousExportDataAsset(SynchronousExportDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Export technical objects from a Data Asset
Declaration
public Task<SynchronousExportDataAssetResponse> SynchronousExportDataAsset(SynchronousExportDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SynchronousExportDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SynchronousExportDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SynchronousExportDataAsset API.
TestConnection(TestConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Test the connection by connecting to the data asset using credentials in the metadata.
Declaration
public Task<TestConnectionResponse> TestConnection(TestConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
TestConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<TestConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use TestConnection API.
UpdateAttribute(UpdateAttributeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific data asset attribute.
Declaration
public Task<UpdateAttributeResponse> UpdateAttribute(UpdateAttributeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAttributeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAttributeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAttribute API.
UpdateCatalog(UpdateCatalogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the data catalog.
Declaration
public Task<UpdateCatalogResponse> UpdateCatalog(UpdateCatalogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCatalogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCatalogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCatalog API.
UpdateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the private reverse connection endpoint.
Declaration
public Task<UpdateCatalogPrivateEndpointResponse> UpdateCatalogPrivateEndpoint(UpdateCatalogPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCatalogPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCatalogPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCatalogPrivateEndpoint API.
UpdateConnection(UpdateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific connection of a data asset.
Declaration
public Task<UpdateConnectionResponse> UpdateConnection(UpdateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateConnection API.
UpdateCustomProperty(UpdateCustomPropertyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific custom property identified by the given key.
Declaration
public Task<UpdateCustomPropertyResponse> UpdateCustomProperty(UpdateCustomPropertyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateCustomPropertyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateCustomPropertyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCustomProperty API.
UpdateDataAsset(UpdateDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific data asset identified by the given key.
Declaration
public Task<UpdateDataAssetResponse> UpdateDataAsset(UpdateDataAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDataAssetRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDataAssetResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDataAsset API.
UpdateEntity(UpdateEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific data entity.
Declaration
public Task<UpdateEntityResponse> UpdateEntity(UpdateEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateEntity API.
UpdateFolder(UpdateFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific folder of a data asset.
Declaration
public Task<UpdateFolderResponse> UpdateFolder(UpdateFolderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateFolderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateFolderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateFolder API.
UpdateGlossary(UpdateGlossaryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific glossary identified by the given key.
Declaration
public Task<UpdateGlossaryResponse> UpdateGlossary(UpdateGlossaryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateGlossaryRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateGlossaryResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateGlossary API.
UpdateJob(UpdateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific job identified by the given key.
Declaration
public Task<UpdateJobResponse> UpdateJob(UpdateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateJob API.
UpdateJobDefinition(UpdateJobDefinitionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update a specific job definition identified by the given key.
Declaration
public Task<UpdateJobDefinitionResponse> UpdateJobDefinition(UpdateJobDefinitionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateJobDefinitionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateJobDefinitionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateJobDefinition API.
UpdateMetastore(UpdateMetastoreRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a metastore resource by identifier.
Declaration
public Task<UpdateMetastoreResponse> UpdateMetastore(UpdateMetastoreRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateMetastoreRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateMetastoreResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateMetastore API.
UpdateNamespace(UpdateNamespaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific namespace identified by the given key.
Declaration
public Task<UpdateNamespaceResponse> UpdateNamespace(UpdateNamespaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateNamespaceRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateNamespaceResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateNamespace API.
UpdatePattern(UpdatePatternRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific pattern identified by the given key.
Declaration
public Task<UpdatePatternResponse> UpdatePattern(UpdatePatternRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePatternRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePatternResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePattern API.
UpdateTerm(UpdateTermRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific glossary term.
Declaration
public Task<UpdateTermResponse> UpdateTerm(UpdateTermRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTermRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTermResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTerm API.
UpdateTermRelationship(UpdateTermRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a specific glossary term relationship.
Declaration
public Task<UpdateTermRelationshipResponse> UpdateTermRelationship(UpdateTermRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTermRelationshipRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTermRelationshipResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTermRelationship API.
UploadCredentials(UploadCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Upload connection credentails and metadata for this connection.
Declaration
public Task<UploadCredentialsResponse> UploadCredentials(UploadCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UploadCredentialsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UploadCredentialsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UploadCredentials API.
Users(UsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns active users in the system.
Declaration
public Task<UsersResponse> Users(UsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UsersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UsersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use Users API.
ValidateConnection(ValidateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validate connection by connecting to the data asset using credentials in metadata.
Declaration
public Task<ValidateConnectionResponse> ValidateConnection(ValidateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidateConnectionRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidateConnectionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidateConnection API.
ValidatePattern(ValidatePatternRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Validate pattern by deriving file groups representing logical entities using the expression
Declaration
public Task<ValidatePatternResponse> ValidatePattern(ValidatePatternRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ValidatePatternRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ValidatePatternResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ValidatePattern API.