Class DataIntegrationClient

Service client instance for DataIntegration.

Inheritance

object

ClientBase

RegionalClientBase

DataIntegrationClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DataintegrationService

Assembly: OCI.DotNetSDK.Dataintegration.dll

Syntax

public class DataIntegrationClient : RegionalClientBase, IDisposable

Constructors

DataIntegrationClient(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 DataIntegrationClient(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 DataIntegrationPaginators Paginators { get; }

Property Value

Type	Description
DataIntegrationPaginators

Waiters

Declaration

public DataIntegrationWaiters Waiters { get; }

Property Value

Type	Description
DataIntegrationWaiters

Methods

ChangeCompartment(ChangeCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a workspace to a specified compartment.

Declaration

public Task<ChangeCompartmentResponse> ChangeCompartment(ChangeCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeCompartmentRequest	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<ChangeCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeCompartment API.

ChangeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a DIS Application to a specified compartment.

Declaration

public Task<ChangeDisApplicationCompartmentResponse> ChangeDisApplicationCompartment(ChangeDisApplicationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeDisApplicationCompartmentRequest	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<ChangeDisApplicationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDisApplicationCompartment API.

CreateApplication(CreateApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an application.

Declaration

public Task<CreateApplicationResponse> CreateApplication(CreateApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApplicationRequest	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<CreateApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApplication API.

CreateApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates detailed description for an application.

Declaration

public Task<CreateApplicationDetailedDescriptionResponse> CreateApplicationDetailedDescription(CreateApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateApplicationDetailedDescriptionRequest	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<CreateApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateApplicationDetailedDescription API.

CreateConnection(CreateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a connection under an existing data asset.

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.

CreateConnectionValidation(CreateConnectionValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a connection validation.

Declaration

public Task<CreateConnectionValidationResponse> CreateConnectionValidation(CreateConnectionValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConnectionValidationRequest	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<CreateConnectionValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateConnectionValidation API.

CreateCopyObjectRequest(CreateCopyObjectRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Copy Metadata Object.

Declaration

public Task<CreateCopyObjectRequestResponse> CreateCopyObjectRequest(CreateCopyObjectRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateCopyObjectRequestRequest	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<CreateCopyObjectRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateCopyObjectRequest API.

CreateDataAsset(CreateDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a data asset with default connection.

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.

CreateDataFlow(CreateDataFlowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new data flow in a project or folder ready for performing data integrations.

Declaration

public Task<CreateDataFlowResponse> CreateDataFlow(CreateDataFlowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDataFlowRequest	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<CreateDataFlowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDataFlow API.

CreateDataFlowValidation(CreateDataFlowValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Accepts the data flow definition in the request payload and creates a data flow validation.

Declaration

public Task<CreateDataFlowValidationResponse> CreateDataFlowValidation(CreateDataFlowValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDataFlowValidationRequest	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<CreateDataFlowValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDataFlowValidation API.

CreateDisApplication(CreateDisApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a DIS Application.

Declaration

public Task<CreateDisApplicationResponse> CreateDisApplication(CreateDisApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDisApplicationRequest	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<CreateDisApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDisApplication API.

CreateDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates detailed description for an application.

Declaration

public Task<CreateDisApplicationDetailedDescriptionResponse> CreateDisApplicationDetailedDescription(CreateDisApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDisApplicationDetailedDescriptionRequest	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<CreateDisApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDisApplicationDetailedDescription API.

CreateEntityShape(CreateEntityShapeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates the data entity shape using the shape from the data asset.

Declaration

public Task<CreateEntityShapeResponse> CreateEntityShape(CreateEntityShapeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateEntityShapeRequest	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<CreateEntityShapeResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateEntityShape API.

CreateExportRequest(CreateExportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Export Metadata Object

Declaration

public Task<CreateExportRequestResponse> CreateExportRequest(CreateExportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateExportRequestRequest	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<CreateExportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateExportRequest API.

CreateExternalPublication(CreateExternalPublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Publish a DataFlow in a OCI DataFlow application.

Declaration

public Task<CreateExternalPublicationResponse> CreateExternalPublication(CreateExternalPublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateExternalPublicationRequest	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<CreateExternalPublicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateExternalPublication API.

CreateExternalPublicationValidation(CreateExternalPublicationValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validates a specific task.

Declaration

public Task<CreateExternalPublicationValidationResponse> CreateExternalPublicationValidation(CreateExternalPublicationValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateExternalPublicationValidationRequest	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<CreateExternalPublicationValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateExternalPublicationValidation API.

CreateFolder(CreateFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a folder in a project or in another folder, limited to two levels of folders. | Folders are used to organize your design-time resources, such as tasks or data flows.

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.

CreateFunctionLibrary(CreateFunctionLibraryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a function library in a project or in another function library, limited to two levels of function libraries. | FunctionLibraries are used to organize your design-time resources, such as tasks or data flows.

Declaration

public Task<CreateFunctionLibraryResponse> CreateFunctionLibrary(CreateFunctionLibraryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateFunctionLibraryRequest	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<CreateFunctionLibraryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateFunctionLibrary API.

CreateImportRequest(CreateImportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Import Metadata Object

Declaration

public Task<CreateImportRequestResponse> CreateImportRequest(CreateImportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateImportRequestRequest	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<CreateImportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateImportRequest API.

CreatePatch(CreatePatchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a patch in an application.

Declaration

public Task<CreatePatchResponse> CreatePatch(CreatePatchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePatchRequest	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<CreatePatchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePatch API.

CreatePipeline(CreatePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new pipeline in a project or folder ready for performing task orchestration.

Declaration

public Task<CreatePipelineResponse> CreatePipeline(CreatePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePipelineRequest	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<CreatePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePipeline API.

CreatePipelineValidation(CreatePipelineValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Accepts the data flow definition in the request payload and creates a pipeline validation.

Declaration

public Task<CreatePipelineValidationResponse> CreatePipelineValidation(CreatePipelineValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreatePipelineValidationRequest	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<CreatePipelineValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreatePipelineValidation API.

CreateProject(CreateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a project. Projects are organizational constructs within a workspace that you use to organize your design-time resources, such as tasks or data flows. Projects can be organized into folders.

Declaration

public Task<CreateProjectResponse> CreateProject(CreateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateProjectRequest	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<CreateProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateProject API.

CreateSchedule(CreateScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint to create a new schedule

Declaration

public Task<CreateScheduleResponse> CreateSchedule(CreateScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateScheduleRequest	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<CreateScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSchedule API.

CreateTask(CreateTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new task ready for performing data integrations. There are specialized types of tasks that include data loader and integration tasks.

Declaration

public Task<CreateTaskResponse> CreateTask(CreateTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateTaskRequest	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<CreateTaskResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateTask API.

CreateTaskRun(CreateTaskRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a data integration task run for the specified task.

Declaration

public Task<CreateTaskRunResponse> CreateTaskRun(CreateTaskRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateTaskRunRequest	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<CreateTaskRunResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateTaskRun API.

CreateTaskSchedule(CreateTaskScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint to be used create TaskSchedule.

Declaration

public Task<CreateTaskScheduleResponse> CreateTaskSchedule(CreateTaskScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateTaskScheduleRequest	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<CreateTaskScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateTaskSchedule API.

CreateTaskValidation(CreateTaskValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Validates a specific task.

Declaration

public Task<CreateTaskValidationResponse> CreateTaskValidation(CreateTaskValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateTaskValidationRequest	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<CreateTaskValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateTaskValidation API.

CreateUserDefinedFunction(CreateUserDefinedFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new UserDefinedFunction in a function library ready for performing data integrations.

Declaration

public Task<CreateUserDefinedFunctionResponse> CreateUserDefinedFunction(CreateUserDefinedFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateUserDefinedFunctionRequest	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<CreateUserDefinedFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateUserDefinedFunction API.

CreateUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.

Declaration

public Task<CreateUserDefinedFunctionValidationResponse> CreateUserDefinedFunctionValidation(CreateUserDefinedFunctionValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateUserDefinedFunctionValidationRequest	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<CreateUserDefinedFunctionValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateUserDefinedFunctionValidation API.

CreateWorkspace(CreateWorkspaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the {@link #getWorkRequest(GetWorkRequestRequest) getWorkRequest} API.

Declaration

public Task<CreateWorkspaceResponse> CreateWorkspace(CreateWorkspaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateWorkspaceRequest	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<CreateWorkspaceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateWorkspace API.

DeleteApplication(DeleteApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes an application using the specified identifier.

Declaration

public Task<DeleteApplicationResponse> DeleteApplication(DeleteApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApplicationRequest	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<DeleteApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApplication API.

DeleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes detailed description of an Application.

Declaration

public Task<DeleteApplicationDetailedDescriptionResponse> DeleteApplicationDetailedDescription(DeleteApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteApplicationDetailedDescriptionRequest	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<DeleteApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteApplicationDetailedDescription API.

DeleteConnection(DeleteConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a connection using the specified identifier.

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.

DeleteConnectionValidation(DeleteConnectionValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a connection validation.

Declaration

public Task<DeleteConnectionValidationResponse> DeleteConnectionValidation(DeleteConnectionValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConnectionValidationRequest	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<DeleteConnectionValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteConnectionValidation API.

DeleteCopyObjectRequest(DeleteCopyObjectRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete copy object request using the specified identifier.

Declaration

public Task<DeleteCopyObjectRequestResponse> DeleteCopyObjectRequest(DeleteCopyObjectRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteCopyObjectRequestRequest	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<DeleteCopyObjectRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteCopyObjectRequest API.

DeleteDataAsset(DeleteDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a data asset using the specified identifier.

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.

DeleteDataFlow(DeleteDataFlowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a data flow from a project or folder using the specified identifier.

Declaration

public Task<DeleteDataFlowResponse> DeleteDataFlow(DeleteDataFlowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDataFlowRequest	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<DeleteDataFlowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDataFlow API.

DeleteDataFlowValidation(DeleteDataFlowValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a data flow validation using the specified identifier.

Declaration

public Task<DeleteDataFlowValidationResponse> DeleteDataFlowValidation(DeleteDataFlowValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDataFlowValidationRequest	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<DeleteDataFlowValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDataFlowValidation API.

DeleteDisApplication(DeleteDisApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a DIS application using the specified identifier.

Declaration

public Task<DeleteDisApplicationResponse> DeleteDisApplication(DeleteDisApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDisApplicationRequest	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<DeleteDisApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDisApplication API.

DeleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes detailed description of an Application.

Declaration

public Task<DeleteDisApplicationDetailedDescriptionResponse> DeleteDisApplicationDetailedDescription(DeleteDisApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDisApplicationDetailedDescriptionRequest	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<DeleteDisApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDisApplicationDetailedDescription API.

DeleteExportRequest(DeleteExportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete export object request using the specified identifier.

Declaration

public Task<DeleteExportRequestResponse> DeleteExportRequest(DeleteExportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteExportRequestRequest	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<DeleteExportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteExportRequest API.

DeleteExternalPublication(DeleteExternalPublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a published object using the specified identifier.

Declaration

public Task<DeleteExternalPublicationResponse> DeleteExternalPublication(DeleteExternalPublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteExternalPublicationRequest	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<DeleteExternalPublicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteExternalPublication API.

DeleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a task validation using the specified identifier.

Declaration

public Task<DeleteExternalPublicationValidationResponse> DeleteExternalPublicationValidation(DeleteExternalPublicationValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteExternalPublicationValidationRequest	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<DeleteExternalPublicationValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteExternalPublicationValidation API.

DeleteFolder(DeleteFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a folder from a project using the specified identifier.

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.

DeleteFunctionLibrary(DeleteFunctionLibraryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a Function Library from a project using the specified identifier.

Declaration

public Task<DeleteFunctionLibraryResponse> DeleteFunctionLibrary(DeleteFunctionLibraryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteFunctionLibraryRequest	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<DeleteFunctionLibraryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteFunctionLibrary API.

DeleteImportRequest(DeleteImportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete import object request using the specified identifier.

Declaration

public Task<DeleteImportRequestResponse> DeleteImportRequest(DeleteImportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteImportRequestRequest	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<DeleteImportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteImportRequest API.

DeletePatch(DeletePatchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a patch using the specified identifier.

Declaration

public Task<DeletePatchResponse> DeletePatch(DeletePatchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePatchRequest	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<DeletePatchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePatch API.

DeletePipeline(DeletePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a pipeline from a project or folder using the specified identifier.

Declaration

public Task<DeletePipelineResponse> DeletePipeline(DeletePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePipelineRequest	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<DeletePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePipeline API.

DeletePipelineValidation(DeletePipelineValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a pipeline validation using the specified identifier.

Declaration

public Task<DeletePipelineValidationResponse> DeletePipelineValidation(DeletePipelineValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeletePipelineValidationRequest	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<DeletePipelineValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeletePipelineValidation API.

DeleteProject(DeleteProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a project from the workspace using the specified identifier.

Declaration

public Task<DeleteProjectResponse> DeleteProject(DeleteProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteProjectRequest	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<DeleteProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteProject API.

DeleteSchedule(DeleteScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint to delete schedule.

Declaration

public Task<DeleteScheduleResponse> DeleteSchedule(DeleteScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteScheduleRequest	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<DeleteScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSchedule API.

DeleteTask(DeleteTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a task using the specified identifier.

Declaration

public Task<DeleteTaskResponse> DeleteTask(DeleteTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteTaskRequest	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<DeleteTaskResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteTask API.

DeleteTaskRun(DeleteTaskRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a task run using the specified identifier.

Declaration

public Task<DeleteTaskRunResponse> DeleteTaskRun(DeleteTaskRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteTaskRunRequest	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<DeleteTaskRunResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteTaskRun API.

DeleteTaskSchedule(DeleteTaskScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint to delete TaskSchedule.

Declaration

public Task<DeleteTaskScheduleResponse> DeleteTaskSchedule(DeleteTaskScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteTaskScheduleRequest	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<DeleteTaskScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteTaskSchedule API.

DeleteTaskValidation(DeleteTaskValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a task validation using the specified identifier.

Declaration

public Task<DeleteTaskValidationResponse> DeleteTaskValidation(DeleteTaskValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteTaskValidationRequest	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<DeleteTaskValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteTaskValidation API.

DeleteUserDefinedFunction(DeleteUserDefinedFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a UserDefinedFunction from a function library using the specified identifier.

Declaration

public Task<DeleteUserDefinedFunctionResponse> DeleteUserDefinedFunction(DeleteUserDefinedFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteUserDefinedFunctionRequest	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<DeleteUserDefinedFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteUserDefinedFunction API.

DeleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes a UserDefinedFunction validation using the specified identifier.

Declaration

public Task<DeleteUserDefinedFunctionValidationResponse> DeleteUserDefinedFunctionValidation(DeleteUserDefinedFunctionValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteUserDefinedFunctionValidationRequest	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<DeleteUserDefinedFunctionValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteUserDefinedFunctionValidation API.

DeleteWorkspace(DeleteWorkspaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a Data Integration workspace resource using the specified identifier.

Declaration

public Task<DeleteWorkspaceResponse> DeleteWorkspace(DeleteWorkspaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteWorkspaceRequest	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<DeleteWorkspaceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteWorkspace API.

GetApplication(GetApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an application using the specified identifier.

Declaration

public Task<GetApplicationResponse> GetApplication(GetApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApplicationRequest	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<GetApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApplication API.

GetApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves detailed description of an Application

Declaration

public Task<GetApplicationDetailedDescriptionResponse> GetApplicationDetailedDescription(GetApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetApplicationDetailedDescriptionRequest	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<GetApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetApplicationDetailedDescription API.

GetCompositeState(GetCompositeStateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get composite state for a given aggregator

Declaration

public Task<GetCompositeStateResponse> GetCompositeState(GetCompositeStateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCompositeStateRequest	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<GetCompositeStateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCompositeState API.

GetConnection(GetConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the connection details using the specified identifier.

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.

GetConnectionValidation(GetConnectionValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a connection validation using the specified identifier.

Declaration

public Task<GetConnectionValidationResponse> GetConnectionValidation(GetConnectionValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConnectionValidationRequest	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<GetConnectionValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetConnectionValidation API.

GetCopyObjectRequest(GetCopyObjectRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the summary/details of object being copied.

Declaration

public Task<GetCopyObjectRequestResponse> GetCopyObjectRequest(GetCopyObjectRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCopyObjectRequestRequest	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<GetCopyObjectRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCopyObjectRequest API.

GetCountStatistic(GetCountStatisticRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves statistics on a workspace. It returns an object with an array of property values, such as the number of projects, | applications, data assets, and so on.

Declaration

public Task<GetCountStatisticResponse> GetCountStatistic(GetCountStatisticRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetCountStatisticRequest	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<GetCountStatisticResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetCountStatistic API.

GetDataAsset(GetDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves details of a data asset using the specified identifier.

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.

GetDataEntity(GetDataEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the data entity details with the given name from live schema.

Declaration

public Task<GetDataEntityResponse> GetDataEntity(GetDataEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataEntityRequest	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<GetDataEntityResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDataEntity API.

GetDataFlow(GetDataFlowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a data flow using the specified identifier.

Declaration

public Task<GetDataFlowResponse> GetDataFlow(GetDataFlowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataFlowRequest	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<GetDataFlowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDataFlow API.

GetDataFlowValidation(GetDataFlowValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a data flow validation using the specified identifier.

Declaration

public Task<GetDataFlowValidationResponse> GetDataFlowValidation(GetDataFlowValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDataFlowValidationRequest	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<GetDataFlowValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDataFlowValidation API.

GetDependentObject(GetDependentObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the details of a dependent object from an application.

Declaration

public Task<GetDependentObjectResponse> GetDependentObject(GetDependentObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDependentObjectRequest	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<GetDependentObjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDependentObject API.

GetDisApplication(GetDisApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an application using the specified OCID.

Declaration

public Task<GetDisApplicationResponse> GetDisApplication(GetDisApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDisApplicationRequest	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<GetDisApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDisApplication API.

GetDisApplicationDetailedDescription(GetDisApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves detailed description of an Application.

Declaration

public Task<GetDisApplicationDetailedDescriptionResponse> GetDisApplicationDetailedDescription(GetDisApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDisApplicationDetailedDescriptionRequest	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<GetDisApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDisApplicationDetailedDescription API.

GetExportRequest(GetExportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the summary/details of object being exported.

Declaration

public Task<GetExportRequestResponse> GetExportRequest(GetExportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetExportRequestRequest	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<GetExportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetExportRequest API.

GetExternalPublication(GetExternalPublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a publshed object in an task using the specified identifier.

Declaration

public Task<GetExternalPublicationResponse> GetExternalPublication(GetExternalPublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetExternalPublicationRequest	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<GetExternalPublicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetExternalPublication API.

GetExternalPublicationValidation(GetExternalPublicationValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves an external publication validation using the specified identifier.

Declaration

public Task<GetExternalPublicationValidationResponse> GetExternalPublicationValidation(GetExternalPublicationValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetExternalPublicationValidationRequest	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<GetExternalPublicationValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetExternalPublicationValidation API.

GetFolder(GetFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a folder using the specified identifier.

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.

GetFunctionLibrary(GetFunctionLibraryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Function Library using the specified identifier.

Declaration

public Task<GetFunctionLibraryResponse> GetFunctionLibrary(GetFunctionLibraryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetFunctionLibraryRequest	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<GetFunctionLibraryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetFunctionLibrary API.

GetImportRequest(GetImportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the summary/details of object being imported.

Declaration

public Task<GetImportRequestResponse> GetImportRequest(GetImportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetImportRequestRequest	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<GetImportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetImportRequest API.

GetPatch(GetPatchRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a patch in an application using the specified identifier.

Declaration

public Task<GetPatchResponse> GetPatch(GetPatchRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPatchRequest	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<GetPatchResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPatch API.

GetPipeline(GetPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a pipeline using the specified identifier.

Declaration

public Task<GetPipelineResponse> GetPipeline(GetPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPipelineRequest	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<GetPipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPipeline API.

GetPipelineValidation(GetPipelineValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a pipeline validation using the specified identifier.

Declaration

public Task<GetPipelineValidationResponse> GetPipelineValidation(GetPipelineValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPipelineValidationRequest	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<GetPipelineValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPipelineValidation API.

GetProject(GetProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a project using the specified identifier.

Declaration

public Task<GetProjectResponse> GetProject(GetProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetProjectRequest	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<GetProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetProject API.

GetPublishedObject(GetPublishedObjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the details of a published object from an application.

Declaration

public Task<GetPublishedObjectResponse> GetPublishedObject(GetPublishedObjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetPublishedObjectRequest	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<GetPublishedObjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPublishedObject API.

GetReference(GetReferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a reference in an application.

Declaration

public Task<GetReferenceResponse> GetReference(GetReferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetReferenceRequest	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<GetReferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetReference API.

GetRuntimeOperator(GetRuntimeOperatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a runtime operator using the specified identifier.

Declaration

public Task<GetRuntimeOperatorResponse> GetRuntimeOperator(GetRuntimeOperatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetRuntimeOperatorRequest	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<GetRuntimeOperatorResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetRuntimeOperator API.

GetRuntimePipeline(GetRuntimePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a runtime pipeline using the specified identifier.

Declaration

public Task<GetRuntimePipelineResponse> GetRuntimePipeline(GetRuntimePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetRuntimePipelineRequest	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<GetRuntimePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetRuntimePipeline API.

GetSchedule(GetScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves schedule by schedule key

Declaration

public Task<GetScheduleResponse> GetSchedule(GetScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetScheduleRequest	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<GetScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSchedule API.

GetSchema(GetSchemaRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a schema that can be accessed using the specified connection.

Declaration

public Task<GetSchemaResponse> GetSchema(GetSchemaRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSchemaRequest	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<GetSchemaResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSchema API.

GetTask(GetTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a task using the specified identifier.

Declaration

public Task<GetTaskResponse> GetTask(GetTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTaskRequest	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<GetTaskResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTask API.

GetTaskRun(GetTaskRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a task run using the specified identifier.

Declaration

public Task<GetTaskRunResponse> GetTaskRun(GetTaskRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTaskRunRequest	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<GetTaskRunResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTaskRun API.

GetTaskSchedule(GetTaskScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint used to get taskSchedule by its key

Declaration

public Task<GetTaskScheduleResponse> GetTaskSchedule(GetTaskScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTaskScheduleRequest	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<GetTaskScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTaskSchedule API.

GetTaskValidation(GetTaskValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a task validation using the specified identifier.

Declaration

public Task<GetTaskValidationResponse> GetTaskValidation(GetTaskValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTaskValidationRequest	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<GetTaskValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTaskValidation API.

GetTemplate(GetTemplateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get an application template using a key.

Declaration

public Task<GetTemplateResponse> GetTemplate(GetTemplateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetTemplateRequest	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<GetTemplateResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetTemplate API.

GetUserDefinedFunction(GetUserDefinedFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a UserDefinedFunction using the specified identifier.

Declaration

public Task<GetUserDefinedFunctionResponse> GetUserDefinedFunction(GetUserDefinedFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserDefinedFunctionRequest	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<GetUserDefinedFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUserDefinedFunction API.

GetUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a UserDefinedFunction validation using the specified identifier.

Declaration

public Task<GetUserDefinedFunctionValidationResponse> GetUserDefinedFunctionValidation(GetUserDefinedFunctionValidationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetUserDefinedFunctionValidationRequest	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<GetUserDefinedFunctionValidationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetUserDefinedFunctionValidation API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the status of the work request with the given ID.

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.

GetWorkspace(GetWorkspaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a Data Integration workspace using the specified identifier.

Declaration

public Task<GetWorkspaceResponse> GetWorkspace(GetWorkspaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkspaceRequest	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<GetWorkspaceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkspace API.

ListApplications(ListApplicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of applications and provides options to filter the list.

Declaration

public Task<ListApplicationsResponse> ListApplications(ListApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListApplicationsRequest	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<ListApplicationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListApplications API.

ListConnectionValidations(ListConnectionValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of connection validations within the specified workspace.

Declaration

public Task<ListConnectionValidationsResponse> ListConnectionValidations(ListConnectionValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConnectionValidationsRequest	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<ListConnectionValidationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListConnectionValidations API.

ListConnections(ListConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all connections.

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.

ListCopyObjectRequests(ListCopyObjectRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the list of copy object requests.

Declaration

public Task<ListCopyObjectRequestsResponse> ListCopyObjectRequests(ListCopyObjectRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListCopyObjectRequestsRequest	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<ListCopyObjectRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListCopyObjectRequests API.

ListDataAssets(ListDataAssetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all data asset summaries.

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.

ListDataEntities(ListDataEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists a summary of data entities from the data asset using the specified connection.

Declaration

public Task<ListDataEntitiesResponse> ListDataEntities(ListDataEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDataEntitiesRequest	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<ListDataEntitiesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDataEntities API.

ListDataFlowValidations(ListDataFlowValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of data flow validations within the specified workspace.

Declaration

public Task<ListDataFlowValidationsResponse> ListDataFlowValidations(ListDataFlowValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDataFlowValidationsRequest	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<ListDataFlowValidationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDataFlowValidations API.

ListDataFlows(ListDataFlowsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of data flows in a project or folder.

Declaration

public Task<ListDataFlowsResponse> ListDataFlows(ListDataFlowsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDataFlowsRequest	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<ListDataFlowsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDataFlows API.

ListDependentObjects(ListDependentObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all dependent objects for a specific application.

Declaration

public Task<ListDependentObjectsResponse> ListDependentObjects(ListDependentObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDependentObjectsRequest	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<ListDependentObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDependentObjects API.

ListDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to list Task Run Lineages within a given time window.

Declaration

public Task<ListDisApplicationTaskRunLineagesResponse> ListDisApplicationTaskRunLineages(ListDisApplicationTaskRunLineagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDisApplicationTaskRunLineagesRequest	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<ListDisApplicationTaskRunLineagesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDisApplicationTaskRunLineages API.

ListDisApplications(ListDisApplicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of DIS Applications in a compartment and provides options to filter the list.

Declaration

public Task<ListDisApplicationsResponse> ListDisApplications(ListDisApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDisApplicationsRequest	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<ListDisApplicationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDisApplications API.

ListExportRequests(ListExportRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the list of export object requests.

Declaration

public Task<ListExportRequestsResponse> ListExportRequests(ListExportRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListExportRequestsRequest	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<ListExportRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListExportRequests API.

ListExternalPublicationValidations(ListExternalPublicationValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a lists of external publication validations in a workspace and provides options to filter the list.

Declaration

public Task<ListExternalPublicationValidationsResponse> ListExternalPublicationValidations(ListExternalPublicationValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListExternalPublicationValidationsRequest	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<ListExternalPublicationValidationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListExternalPublicationValidations API.

ListExternalPublications(ListExternalPublicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of external publications in an application and provides options to filter the list.

Declaration

public Task<ListExternalPublicationsResponse> ListExternalPublications(ListExternalPublicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListExternalPublicationsRequest	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<ListExternalPublicationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListExternalPublications API.

ListFolders(ListFoldersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of folders in a project and provides options to filter the list.

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.

ListFunctionLibraries(ListFunctionLibrariesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of function libraries in a project and provides options to filter the list.

Declaration

public Task<ListFunctionLibrariesResponse> ListFunctionLibraries(ListFunctionLibrariesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListFunctionLibrariesRequest	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<ListFunctionLibrariesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListFunctionLibraries API.

ListImportRequests(ListImportRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the list of import object requests.

Declaration

public Task<ListImportRequestsResponse> ListImportRequests(ListImportRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListImportRequestsRequest	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<ListImportRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListImportRequests API.

ListPatchChanges(ListPatchChangesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of patches in an application and provides options to filter the list.

Declaration

public Task<ListPatchChangesResponse> ListPatchChanges(ListPatchChangesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPatchChangesRequest	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<ListPatchChangesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPatchChanges API.

ListPatches(ListPatchesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of patches in an application and provides options to filter the list. For listing changes based on a period and logical objects changed, see ListPatchChanges API.

Declaration

public Task<ListPatchesResponse> ListPatches(ListPatchesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPatchesRequest	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<ListPatchesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPatches API.

ListPipelineValidations(ListPipelineValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of pipeline validations within the specified workspace.

Declaration

public Task<ListPipelineValidationsResponse> ListPipelineValidations(ListPipelineValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelineValidationsRequest	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<ListPipelineValidationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelineValidations API.

ListPipelines(ListPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.

Declaration

public Task<ListPipelinesResponse> ListPipelines(ListPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPipelinesRequest	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<ListPipelinesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPipelines API.

ListProjects(ListProjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a lists of projects in a workspace and provides options to filter the list.

Declaration

public Task<ListProjectsResponse> ListProjects(ListProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListProjectsRequest	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<ListProjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListProjects API.

ListPublishedObjects(ListPublishedObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all the published objects for a specified application.

Declaration

public Task<ListPublishedObjectsResponse> ListPublishedObjects(ListPublishedObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListPublishedObjectsRequest	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<ListPublishedObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPublishedObjects API.

ListReferences(ListReferencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of references in an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections.

Declaration

public Task<ListReferencesResponse> ListReferences(ListReferencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListReferencesRequest	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<ListReferencesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListReferences API.

ListRuntimeOperators(ListRuntimeOperatorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to list runtime operators with filtering options

Declaration

public Task<ListRuntimeOperatorsResponse> ListRuntimeOperators(ListRuntimeOperatorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRuntimeOperatorsRequest	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<ListRuntimeOperatorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListRuntimeOperators API.

ListRuntimePipelines(ListRuntimePipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to list runtime pipelines with filtering options

Declaration

public Task<ListRuntimePipelinesResponse> ListRuntimePipelines(ListRuntimePipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListRuntimePipelinesRequest	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<ListRuntimePipelinesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListRuntimePipelines API.

ListSchedules(ListSchedulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Use this endpoint to list schedules.

Declaration

public Task<ListSchedulesResponse> ListSchedules(ListSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSchedulesRequest	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<ListSchedulesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSchedules API.

ListSchemas(ListSchemasRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all the schemas that can be accessed using the specified connection.

Declaration

public Task<ListSchemasResponse> ListSchemas(ListSchemasRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSchemasRequest	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<ListSchemasResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSchemas API.

ListTaskRunLineages(ListTaskRunLineagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to list Task Run Lineages within a given time window.

Declaration

public Task<ListTaskRunLineagesResponse> ListTaskRunLineages(ListTaskRunLineagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTaskRunLineagesRequest	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<ListTaskRunLineagesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTaskRunLineages API.

ListTaskRunLogs(ListTaskRunLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets log entries for task runs using its key.

Declaration

public Task<ListTaskRunLogsResponse> ListTaskRunLogs(ListTaskRunLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTaskRunLogsRequest	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<ListTaskRunLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTaskRunLogs API.

ListTaskRuns(ListTaskRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of task runs and provides options to filter the list.

Declaration

public Task<ListTaskRunsResponse> ListTaskRuns(ListTaskRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTaskRunsRequest	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<ListTaskRunsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTaskRuns API.

ListTaskSchedules(ListTaskSchedulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to get the list of all the TaskSchedule objects.

Declaration

public Task<ListTaskSchedulesResponse> ListTaskSchedules(ListTaskSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTaskSchedulesRequest	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<ListTaskSchedulesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTaskSchedules API.

ListTaskValidations(ListTaskValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of task validations within the specified workspace.

Declaration

public Task<ListTaskValidationsResponse> ListTaskValidations(ListTaskValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTaskValidationsRequest	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<ListTaskValidationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTaskValidations API.

ListTasks(ListTasksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of all tasks in a specified project or folder.

Declaration

public Task<ListTasksResponse> ListTasks(ListTasksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTasksRequest	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<ListTasksResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTasks API.

ListTemplates(ListTemplatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This endpoint can be used to list application templates with filtering options.

Declaration

public Task<ListTemplatesResponse> ListTemplates(ListTemplatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListTemplatesRequest	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<ListTemplatesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListTemplates API.

ListUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.

Declaration

public Task<ListUserDefinedFunctionValidationsResponse> ListUserDefinedFunctionValidations(ListUserDefinedFunctionValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserDefinedFunctionValidationsRequest	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<ListUserDefinedFunctionValidationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserDefinedFunctionValidations API.

ListUserDefinedFunctions(ListUserDefinedFunctionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of UserDefinedFunctions in a function library.

Declaration

public Task<ListUserDefinedFunctionsResponse> ListUserDefinedFunctions(ListUserDefinedFunctionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListUserDefinedFunctionsRequest	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<ListUserDefinedFunctionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListUserDefinedFunctions API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves 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)

Retrieves 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.

ListWorkspaces(ListWorkspacesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of Data Integration workspaces.

Declaration

public Task<ListWorkspacesResponse> ListWorkspaces(ListWorkspacesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkspacesRequest	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<ListWorkspacesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkspaces API.

StartWorkspace(StartWorkspaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts a workspace.

Declaration

public Task<StartWorkspaceResponse> StartWorkspace(StartWorkspaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartWorkspaceRequest	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<StartWorkspaceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartWorkspace API.

StopWorkspace(StopWorkspaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops a workspace.

Declaration

public Task<StopWorkspaceResponse> StopWorkspace(StopWorkspaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopWorkspaceRequest	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<StopWorkspaceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopWorkspace API.

UpdateApplication(UpdateApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an application.

Declaration

public Task<UpdateApplicationResponse> UpdateApplication(UpdateApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateApplicationRequest	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<UpdateApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateApplication API.

UpdateApplicationDetailedDescription(UpdateApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the detailed description of an Application.

Declaration

public Task<UpdateApplicationDetailedDescriptionResponse> UpdateApplicationDetailedDescription(UpdateApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateApplicationDetailedDescriptionRequest	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<UpdateApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateApplicationDetailedDescription API.

UpdateConnection(UpdateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a connection under 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.

UpdateCopyObjectRequest(UpdateCopyObjectRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the status of a copy object request.

Declaration

public Task<UpdateCopyObjectRequestResponse> UpdateCopyObjectRequest(UpdateCopyObjectRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateCopyObjectRequestRequest	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<UpdateCopyObjectRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateCopyObjectRequest API.

UpdateDataAsset(UpdateDataAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific data asset with default connection.

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.

UpdateDataFlow(UpdateDataFlowRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific data flow.

Declaration

public Task<UpdateDataFlowResponse> UpdateDataFlow(UpdateDataFlowRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDataFlowRequest	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<UpdateDataFlowResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDataFlow API.

UpdateDisApplication(UpdateDisApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a DIS Application.

Declaration

public Task<UpdateDisApplicationResponse> UpdateDisApplication(UpdateDisApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDisApplicationRequest	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<UpdateDisApplicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDisApplication API.

UpdateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the detailed description of an Application.

Declaration

public Task<UpdateDisApplicationDetailedDescriptionResponse> UpdateDisApplicationDetailedDescription(UpdateDisApplicationDetailedDescriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDisApplicationDetailedDescriptionRequest	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<UpdateDisApplicationDetailedDescriptionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDisApplicationDetailedDescription API.

UpdateExportRequest(UpdateExportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the status of a export object request.

Declaration

public Task<UpdateExportRequestResponse> UpdateExportRequest(UpdateExportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateExportRequestRequest	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<UpdateExportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateExportRequest API.

UpdateExternalPublication(UpdateExternalPublicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the external publication object.

Declaration

public Task<UpdateExternalPublicationResponse> UpdateExternalPublication(UpdateExternalPublicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateExternalPublicationRequest	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<UpdateExternalPublicationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateExternalPublication API.

UpdateFolder(UpdateFolderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific folder.

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.

UpdateFunctionLibrary(UpdateFunctionLibraryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific Function Library.

Declaration

public Task<UpdateFunctionLibraryResponse> UpdateFunctionLibrary(UpdateFunctionLibraryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateFunctionLibraryRequest	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<UpdateFunctionLibraryResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateFunctionLibrary API.

UpdateImportRequest(UpdateImportRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the status of a import object request.

Declaration

public Task<UpdateImportRequestResponse> UpdateImportRequest(UpdateImportRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateImportRequestRequest	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<UpdateImportRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateImportRequest API.

UpdatePipeline(UpdatePipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific pipeline.

Declaration

public Task<UpdatePipelineResponse> UpdatePipeline(UpdatePipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdatePipelineRequest	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<UpdatePipelineResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdatePipeline API.

UpdateProject(UpdateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific project.

Declaration

public Task<UpdateProjectResponse> UpdateProject(UpdateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateProjectRequest	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<UpdateProjectResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateProject API.

UpdateReference(UpdateReferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the application references. For example, to map a data asset to a different target object.

Declaration

public Task<UpdateReferenceResponse> UpdateReference(UpdateReferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateReferenceRequest	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<UpdateReferenceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateReference API.

UpdateSchedule(UpdateScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint used to update the schedule

Declaration

public Task<UpdateScheduleResponse> UpdateSchedule(UpdateScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateScheduleRequest	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<UpdateScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSchedule API.

UpdateTask(UpdateTaskRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific task. For example, you can update the task description or move the task to a different folder by changing the aggregatorKey to a different folder in the registry.

Declaration

public Task<UpdateTaskResponse> UpdateTask(UpdateTaskRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateTaskRequest	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<UpdateTaskResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateTask API.

UpdateTaskRun(UpdateTaskRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the status of the task run. For example, aborts a task run.

Declaration

public Task<UpdateTaskRunResponse> UpdateTaskRun(UpdateTaskRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateTaskRunRequest	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<UpdateTaskRunResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateTaskRun API.

UpdateTaskSchedule(UpdateTaskScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Endpoint used to update the TaskSchedule

Declaration

public Task<UpdateTaskScheduleResponse> UpdateTaskSchedule(UpdateTaskScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateTaskScheduleRequest	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<UpdateTaskScheduleResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateTaskSchedule API.

UpdateUserDefinedFunction(UpdateUserDefinedFunctionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific UserDefinedFunction.

Declaration

public Task<UpdateUserDefinedFunctionResponse> UpdateUserDefinedFunction(UpdateUserDefinedFunctionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateUserDefinedFunctionRequest	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<UpdateUserDefinedFunctionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateUserDefinedFunction API.

UpdateWorkspace(UpdateWorkspaceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified Data Integration workspace.

Declaration

public Task<UpdateWorkspaceResponse> UpdateWorkspace(UpdateWorkspaceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateWorkspaceRequest	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<UpdateWorkspaceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateWorkspace API.

Implements

IDisposable