DataIntegrationClient

class oci.data_integration.DataIntegrationClient(config, **kwargs)

Use the Data Integration Service APIs to perform common extract, load, and transform (ETL) tasks.

Methods

__init__(config, **kwargs) Creates a new service client
change_compartment(workspace_id, …) The workspace will be moved to the desired compartment.
create_application(workspace_id, …) Creates an application.
create_connection(workspace_id, …) Creates a connection under an existing data asset.
create_connection_validation(workspace_id, …) Creates a connection validation.
create_data_asset(workspace_id, …) Creates a data asset with default connection.
create_data_flow(workspace_id, …) Creates a new data flow in a project or folder ready for performing data integrations.
create_data_flow_validation(workspace_id, …) The endpoint accepts the DataFlow object definition in the request payload and creates a DataFlow object validation.
create_entity_shape(workspace_id, …) Retrieves the data entity shape from the end data system.
create_folder(workspace_id, …) Creates a folder in a project or in another folder, limited to two levels of folders.
create_patch(workspace_id, application_key, …) Creates a patch in an application.
create_project(workspace_id, …) Creates a project.
create_task(workspace_id, …) Creates a new task ready for performing data integrations.
create_task_run(workspace_id, …) Creates a data integration task or task run.
create_task_validation(workspace_id, …) Validates a specific task.
create_workspace(create_workspace_details, …) Creates a new Data Integration Workspace ready for performing data integration.
delete_application(workspace_id, …) Removes an application using the specified identifier.
delete_connection(workspace_id, …) Removes a connection using the specified identifier.
delete_connection_validation(workspace_id, …) Successfully accepted the delete request.
delete_data_asset(workspace_id, …) Removes a data asset using the specified identifier.
delete_data_flow(workspace_id, …) Removes a data flow from a project or folder using the specified identifier.
delete_data_flow_validation(workspace_id, …) Removes a data flow validation using the specified identifier.
delete_folder(workspace_id, folder_key, **kwargs) Removes a folder from a project using the specified identifier.
delete_patch(workspace_id, application_key, …) Removes a patch using the specified identifier.
delete_project(workspace_id, project_key, …) Removes a project from the workspace using the specified identifier.
delete_task(workspace_id, task_key, **kwargs) Removes a task using the specified identifier.
delete_task_run(workspace_id, …) Deletes a task run using the specified identifier.
delete_task_validation(workspace_id, …) Removes a task validation using the specified identifier.
delete_workspace(workspace_id, **kwargs) Deletes a Data Integration Workspace resource by identifier
get_application(workspace_id, …) Retrieves an application using the specified identifier.
get_connection(workspace_id, connection_key, …) Retrieves the connection details using the specified identifier.
get_connection_validation(workspace_id, …) Retrieves a connection validation using the specified identifier.
get_count_statistic(workspace_id, …) Retrieves statistics on a workspace.
get_data_asset(workspace_id, data_asset_key, …) Retrieves details of a data asset using the specified identifier.
get_data_entity(workspace_id, …) Retrieves the data entity details with the given name from live schema.
get_data_flow(workspace_id, data_flow_key, …) Retrieves a data flow using the specified identifier.
get_data_flow_validation(workspace_id, …) Retrieves a data flow validation using the specified identifier.
get_dependent_object(workspace_id, …) Retrieves the details of a dependent object from an application.
get_folder(workspace_id, folder_key, **kwargs) Retrieves a folder using the specified identifier.
get_patch(workspace_id, application_key, …) Retrieves a patch in an application using the specified identifier.
get_project(workspace_id, project_key, **kwargs) Retrieves a project using the specified identifier.
get_published_object(workspace_id, …) Retrieves the details of a published object from an application.
get_schema(workspace_id, connection_key, …) Retrieves a schema that can be accessed using the specified connection.
get_task(workspace_id, task_key, **kwargs) Retrieves a task using the specified identifier.
get_task_run(workspace_id, application_key, …) Retrieves a task run using the specified identifier.
get_task_validation(workspace_id, …) Retrieves a task validation using the specified identifier.
get_work_request(work_request_id, **kwargs) Gets the status of the work request with the given ID.
get_workspace(workspace_id, **kwargs) Gets a Data Integration Workspace by identifier
list_applications(workspace_id, **kwargs) Retrieves a list of applications and provides options to filter the list.
list_connection_validations(workspace_id, …) Retrieves a list of connection validations within the specified workspace.
list_connections(workspace_id, …) Retrieves a list of all connections.
list_data_assets(workspace_id, **kwargs) This endpoint can be used to list all data asset summaries
list_data_entities(workspace_id, …) Retrieves a list of summaries of data entities present in the schema identified by schema name.
list_data_flow_validations(workspace_id, …) Retrieves a list of data flow validations within the specified workspace
list_data_flows(workspace_id, **kwargs) Retrieves a list of data flows in a project or folder.
list_dependent_objects(workspace_id, …) Retrieves a list of all dependent objects for a specific application.
list_folders(workspace_id, **kwargs) Retrieves a list of folders in a project and provides options to filter the list.
list_patches(workspace_id, application_key, …) Retrieves a list of patches in an application and provides options to filter the list.
list_projects(workspace_id, **kwargs) Retrieves a lists of projects in a workspace and provides options to filter the list.
list_published_objects(workspace_id, …) Retrieves a list of all the published objects for a specified application.
list_schemas(workspace_id, connection_key, …) Retrieves a list of all the schemas that can be accessed using the specified connection.
list_task_run_logs(workspace_id, …) Get log entries for task runs using its key
list_task_runs(workspace_id, …) Retrieves a list of task runs and provides options to filter the list.
list_task_validations(workspace_id, **kwargs) Retrieves a list of task validations within the specified workspace.
list_tasks(workspace_id, **kwargs) Retrieves a list of all tasks in a specified project or folder.
list_work_request_errors(work_request_id, …) Return a (paginated) list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs) Return a (paginated) list of logs for a given work request.
list_work_requests(compartment_id, **kwargs) Lists the work requests in a compartment.
list_workspaces(compartment_id, **kwargs) Returns a list of Data Integration Workspaces.
start_workspace(workspace_id, **kwargs) The workspace will be started.
stop_workspace(workspace_id, **kwargs) The workspace will be stopped.
update_application(workspace_id, …) Updates an application.
update_connection(workspace_id, …) Updates a connection under a data asset.
update_data_asset(workspace_id, …) Updates a specific data asset with default connection.
update_data_flow(workspace_id, …) Updates a specific data flow.
update_folder(workspace_id, folder_key, …) Updates a specific folder.
update_project(workspace_id, project_key, …) Updates a specific project.
update_task(workspace_id, task_key, …) Updates a specific task.
update_task_run(workspace_id, …) Updates the status of the task run.
update_workspace(workspace_id, …) Updates the Data Integration Workspace
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

change_compartment(workspace_id, change_compartment_details, **kwargs)

The workspace will be moved to the desired compartment.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • change_compartment_details (ChangeCompartmentDetails) – (required) The details of change compartment action.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_application(workspace_id, create_application_details, **kwargs)

Creates an application.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_application_details (CreateApplicationDetails) – (required) The details needed to create an application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Application

Return type:

Response

create_connection(workspace_id, create_connection_details, **kwargs)

Creates a connection under an existing data asset.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_connection_details (CreateConnectionDetails) – (required) Request body parameter for connection details
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

create_connection_validation(workspace_id, create_connection_validation_details, **kwargs)

Creates a connection validation.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_connection_validation_details (CreateConnectionValidationDetails) – (required) Connection info
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConnectionValidation

Return type:

Response

create_data_asset(workspace_id, create_data_asset_details, **kwargs)

Creates a data asset with default connection.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_data_asset_details (CreateDataAssetDetails) – (required) Request body parameter for data asset details
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAsset

Return type:

Response

create_data_flow(workspace_id, create_data_flow_details, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_data_flow_details (CreateDataFlowDetails) – (required) The details needed to create a new data flow.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlow

Return type:

Response

create_data_flow_validation(workspace_id, create_data_flow_validation_details, **kwargs)

The endpoint accepts the DataFlow object definition in the request payload and creates a DataFlow object validation.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_data_flow_validation_details (CreateDataFlowValidationDetails) – (required) Details for the new DataFlow object.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlowValidation

Return type:

Response

create_entity_shape(workspace_id, connection_key, schema_resource_name, create_entity_shape_details, **kwargs)

Retrieves the data entity shape from the end data system. The input can specify the data entity to get the shape for. For databases, this can be retrieved from the database data dictionary. For files, some hints as to the file properties can also be supplied in the input.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • schema_resource_name (str) – (required) Schema resource name used for retrieving schemas
  • create_entity_shape_details (CreateEntityShapeDetails) – (required) The details of the data entity to use to infer the data entity shape.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type EntityShape

Return type:

Response

create_folder(workspace_id, create_folder_details, **kwargs)

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.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_folder_details (CreateFolderDetails) – (required) The details needed to create a folder.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Folder

Return type:

Response

create_patch(workspace_id, application_key, create_patch_details, **kwargs)

Creates a patch in an application.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • create_patch_details (CreatePatchDetails) – (required) Detailed needed to create a patch in an application.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

create_project(workspace_id, create_project_details, **kwargs)

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.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_project_details (CreateProjectDetails) – (required) The details needed to create a project in a workspace.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Project

Return type:

Response

create_task(workspace_id, create_task_details, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_task_details (CreateTaskDetails) – (required) The details needed to create a new task.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Task

Return type:

Response

create_task_run(workspace_id, application_key, create_task_run_details, **kwargs)

Creates a data integration task or task run. The task can be based on a dataflow design or a task.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • create_task_run_details (CreateTaskRunDetails) – (required) The details needed to create a task run.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskRun

Return type:

Response

create_task_validation(workspace_id, create_task_validation_details, **kwargs)

Validates a specific task.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • create_task_validation_details (CreateTaskValidationDetails) – (required) Task info
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskValidation

Return type:

Response

create_workspace(create_workspace_details, **kwargs)

Creates a new Data Integration Workspace ready for performing data integration.

Parameters:
  • create_workspace_details (CreateWorkspaceDetails) – (required) Details for the new Data Integration Workspace.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_application(workspace_id, application_key, **kwargs)

Removes an application using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_connection(workspace_id, connection_key, **kwargs)

Removes a connection using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_connection_validation(workspace_id, connection_validation_key, **kwargs)

Successfully accepted the delete request. The connection validation will be deleted.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_validation_key (str) – (required) key of the connection validation.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_data_asset(workspace_id, data_asset_key, **kwargs)

Removes a data asset using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_asset_key (str) – (required) Data asset key.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_data_flow(workspace_id, data_flow_key, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_flow_key (str) – (required) DIS DataFlow key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_data_flow_validation(workspace_id, data_flow_validation_key, **kwargs)

Removes a data flow validation using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_flow_validation_key (str) – (required) key of the dataflow validation.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_folder(workspace_id, folder_key, **kwargs)

Removes a folder from a project using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • folder_key (str) – (required) DIS Folder key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_patch(workspace_id, application_key, patch_key, **kwargs)

Removes a patch using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • patch_key (str) – (required) DIS patch key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_project(workspace_id, project_key, **kwargs)

Removes a project from the workspace using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • project_key (str) – (required) DIS Project key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_task(workspace_id, task_key, **kwargs)

Removes a task using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • task_key (str) – (required) DIS Task key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_task_run(workspace_id, application_key, task_run_key, **kwargs)

Deletes a task run using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • task_run_key (str) – (required) DIS taskRun key
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_task_validation(workspace_id, task_validation_key, **kwargs)

Removes a task validation using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • task_validation_key (str) – (required) key of the task validation.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

delete_workspace(workspace_id, **kwargs)

Deletes a Data Integration Workspace resource by identifier

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • quiesce_timeout (int) – (optional) This parameter allows users to set the timeout for DIS to gracefully close down any running jobs before stopping the workspace.
  • is_force_operation (bool) – (optional) This parameter allows users to force close down the workspace.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_application(workspace_id, application_key, **kwargs)

Retrieves an application using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Application

Return type:

Response

get_connection(workspace_id, connection_key, **kwargs)

Retrieves the connection details using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

get_connection_validation(workspace_id, connection_validation_key, **kwargs)

Retrieves a connection validation using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_validation_key (str) – (required) key of the connection validation.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConnectionValidation

Return type:

Response

get_count_statistic(workspace_id, count_statistic_key, **kwargs)
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.
Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • count_statistic_key (str) – (required) A unique key of the container object, such as workspace, project, and so on, to count statistics for. The statistics is fetched for the given key.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CountStatistic

Return type:

Response

get_data_asset(workspace_id, data_asset_key, **kwargs)

Retrieves details of a data asset using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_asset_key (str) – (required) Data asset key.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAsset

Return type:

Response

get_data_entity(workspace_id, connection_key, schema_resource_name, data_entity_key, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • schema_resource_name (str) – (required) Schema resource name used for retrieving schemas
  • data_entity_key (str) – (required) Name of the data entity
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataEntity

Return type:

Response

get_data_flow(workspace_id, data_flow_key, **kwargs)

Retrieves a data flow using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_flow_key (str) – (required) DIS DataFlow key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlow

Return type:

Response

get_data_flow_validation(workspace_id, data_flow_validation_key, **kwargs)

Retrieves a data flow validation using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_flow_validation_key (str) – (required) key of the dataflow validation.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlowValidation

Return type:

Response

get_dependent_object(workspace_id, application_key, dependent_object_key, **kwargs)

Retrieves the details of a dependent object from an application.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • dependent_object_key (str) – (required) DIS dependent object key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DependentObject

Return type:

Response

get_folder(workspace_id, folder_key, **kwargs)

Retrieves a folder using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • folder_key (str) – (required) DIS Folder key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Folder

Return type:

Response

get_patch(workspace_id, application_key, patch_key, **kwargs)

Retrieves a patch in an application using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • patch_key (str) – (required) DIS patch key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Patch

Return type:

Response

get_project(workspace_id, project_key, **kwargs)

Retrieves a project using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • project_key (str) – (required) DIS Project key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Project

Return type:

Response

get_published_object(workspace_id, application_key, published_object_key, **kwargs)

Retrieves the details of a published object from an application.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • published_object_key (str) – (required) DIS published object key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • expand_references (str) – (optional) This is used to expand references of the object. If value is true, then all referenced objects will be expanded. If value is false, then shallow objects will be returned in place of references. Default is false. <br><br><B>Examples:-</B><br> <ul> <li><B>?expandReferences=true</B> returns all objects of type data loader task</li> </ul>
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublishedObject

Return type:

Response

get_schema(workspace_id, connection_key, schema_resource_name, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • schema_resource_name (str) – (required) Schema resource name used for retrieving schemas
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Schema

Return type:

Response

get_task(workspace_id, task_key, **kwargs)

Retrieves a task using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • task_key (str) – (required) DIS Task key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Task

Return type:

Response

get_task_run(workspace_id, application_key, task_run_key, **kwargs)

Retrieves a task run using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • task_run_key (str) – (required) DIS taskRun key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskRun

Return type:

Response

get_task_validation(workspace_id, task_validation_key, **kwargs)

Retrieves a task validation using the specified identifier.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • task_validation_key (str) – (required) key of the task validation.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskValidation

Return type:

Response

get_work_request(work_request_id, **kwargs)

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

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type WorkRequest

Return type:

Response

get_workspace(workspace_id, **kwargs)

Gets a Data Integration Workspace by identifier

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Workspace

Return type:

Response

list_applications(workspace_id, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the published object.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ApplicationSummaryCollection

Return type:

Response

list_connection_validations(workspace_id, **kwargs)

Retrieves a list of connection validations within the specified workspace.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • key (str) – (optional) This filter parameter can be used to filter by the key of the object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (str) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConnectionValidationSummaryCollection

Return type:

Response

list_connections(workspace_id, data_asset_key, **kwargs)

Retrieves a list of all connections.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_asset_key (str) – (required) This filter parameter can be used to filter by the data asset key of the object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • type (str) – (optional) Type of the object to filter the results with.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ConnectionSummaryCollection

Return type:

Response

list_data_assets(workspace_id, **kwargs)

This endpoint can be used to list all data asset summaries

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • type (str) – (optional) Type of the object to filter the results with.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAssetSummaryCollection

Return type:

Response

list_data_entities(workspace_id, connection_key, schema_resource_name, **kwargs)

Retrieves a list of summaries of data entities present in the schema identified by schema name. | A live query is run on the data asset identified via the connection specified.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • schema_resource_name (str) – (required) Schema resource name used for retrieving schemas
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • type (str) – (optional) Type of the object to filter the results with.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataEntitySummaryCollection

Return type:

Response

list_data_flow_validations(workspace_id, **kwargs)

Retrieves a list of data flow validations within the specified workspace

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • key (str) – (optional) This filter parameter can be used to filter by the key of the object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (str) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlowValidationSummaryCollection

Return type:

Response

list_data_flows(workspace_id, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • folder_id (str) – (optional) Unique key of the folder
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlowSummaryCollection

Return type:

Response

list_dependent_objects(workspace_id, application_key, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the published object.
  • type (list[str]) – (optional) This filter parameter can be used to filter by the object type of the object. This parameter can be suffixed with an optional filter operator InSubtree. For DIS APIs we will filter based on type Task.
  • type_in_subtree (str) – (optional) This is used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DependentObjectSummaryCollection

Return type:

Response

list_folders(workspace_id, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • aggregator_key (str) – (optional) This filter parameter can be used to filter by the project or the folder object.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FolderSummaryCollection

Return type:

Response

list_patches(workspace_id, application_key, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the published object.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PatchSummaryCollection

Return type:

Response

list_projects(workspace_id, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ProjectSummaryCollection

Return type:

Response

list_published_objects(workspace_id, application_key, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the published object.
  • type (list[str]) – (optional) This filter parameter can be used to filter by the object type of the object. This parameter can be suffixed with an optional filter operator InSubtree. For DIS APIs we will filter based on type Task.
  • type_in_subtree (str) – (optional) This is used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublishedObjectSummaryCollection

Return type:

Response

list_schemas(workspace_id, connection_key, schema_resource_name, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • schema_resource_name (str) – (required) Schema resource name used for retrieving schemas
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SchemaSummaryCollection

Return type:

Response

list_task_run_logs(workspace_id, application_key, task_run_key, **kwargs)

Get log entries for task runs using its key

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • task_run_key (str) – (required) DIS taskRun key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of TaskRunLogSummary

Return type:

Response

list_task_runs(workspace_id, application_key, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskRunSummaryCollection

Return type:

Response

list_task_validations(workspace_id, **kwargs)

Retrieves a list of task validations within the specified workspace.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • key (str) – (optional) This filter parameter can be used to filter by the key of the object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • identifier (str) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskValidationSummaryCollection

Return type:

Response

list_tasks(workspace_id, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • folder_id (str) – (optional) Unique key of the folder
  • fields (list[str]) – (optional) This parameter allows users to specify which fields to get for an object.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • key (list[str]) – (optional) This filter parameter can be used to filter by the key of the object.
  • identifier (list[str]) – (optional) This filter parameter can be used to filter by the identifier of the object.
  • type (list[str]) – (optional) This filter parameter can be used to filter by the object type of the object. This parameter can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered. <br><br><B>Examples:-</B><br> <ul> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=false</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK</B> returns all objects of type data loader task</li> <li><B>?type=DATA_LOADER_TASK&typeInSubtree=true</B> returns all objects of type data loader task</li> </ul>
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskSummaryCollection

Return type:

Response

list_work_request_errors(work_request_id, **kwargs)

Return a (paginated) list of errors for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestError

Return type:

Response

list_work_request_logs(work_request_id, **kwargs)

Return a (paginated) list of logs for a given work request.

Parameters:
  • work_request_id (str) – (required) The ID of the asynchronous request.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestLogEntry

Return type:

Response

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • work_request_status (str) –

    (optional) Work Request status.

    Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkRequestSummary

Return type:

Response

list_workspaces(compartment_id, **kwargs)

Returns a list of Data Integration Workspaces.

Parameters:
  • compartment_id (str) – (required) The ID of the compartment in which to list resources.
  • name (str) – (optional) This filter parameter can be used to filter by the name of the object.
  • limit (int) – (optional) This parameter allows users to set the maximum number of items to return per page. The value must be between 1 and 100 (inclusive). Default value is 100.
  • page (str) – (optional) This parameter will control pagination. Values for the parameter should come from the opc-next-page or opc-prev-page header in previous response.
  • lifecycle_state (str) –

    (optional) Lifecycle state of the resource.

    Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “STARTING”, “STOPPING”, “STOPPED”

  • sort_order (str) –

    (optional) This parameter is used to control the sort order. Supported values are ASC (ascending) and DESC (descending).

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) This parameter allows users to specify a sort field. Supported sort fields are name, identifier, timeCreated, and timeUpdated. Default sort order is the descending order of timeCreated (most recently created objects at the top). Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order).

    Allowed values are: “TIME_CREATED”, “DISPLAY_NAME”

  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of WorkspaceSummary

Return type:

Response

start_workspace(workspace_id, **kwargs)

The workspace will be started.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

stop_workspace(workspace_id, **kwargs)

The workspace will be stopped.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • quiesce_timeout (int) – (optional) This parameter allows users to set the timeout for DIS to gracefully close down any running jobs before stopping the workspace.
  • is_force_operation (bool) – (optional) This parameter allows users to force close down the workspace.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) Caller may provide “retry tokens” allowing them to retry an operation
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

update_application(workspace_id, application_key, update_application_details, **kwargs)

Updates an application.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • update_application_details (UpdateApplicationDetails) – (required) The details needed to update an application.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Application

Return type:

Response

update_connection(workspace_id, connection_key, update_connection_details, **kwargs)

Updates a connection under a data asset.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • connection_key (str) – (required) The connection key
  • update_connection_details (UpdateConnectionDetails) – (required) Request body parameter for connection details
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Connection

Return type:

Response

update_data_asset(workspace_id, data_asset_key, update_data_asset_details, **kwargs)

Updates a specific data asset with default connection.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_asset_key (str) – (required) Data asset key.
  • update_data_asset_details (UpdateDataAssetDetails) – (required) Request body parameter for data asset details
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataAsset

Return type:

Response

update_data_flow(workspace_id, data_flow_key, update_data_flow_details, **kwargs)

Updates a specific data flow.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • data_flow_key (str) – (required) DIS DataFlow key
  • update_data_flow_details (UpdateDataFlowDetails) – (required) The details needed to updated a data flow.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DataFlow

Return type:

Response

update_folder(workspace_id, folder_key, update_folder_details, **kwargs)

Updates a specific folder.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • folder_key (str) – (required) DIS Folder key
  • update_folder_details (UpdateFolderDetails) – (required) The details needed to update a folder.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Folder

Return type:

Response

update_project(workspace_id, project_key, update_project_details, **kwargs)

Updates a specific project.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • project_key (str) – (required) DIS Project key
  • update_project_details (UpdateProjectDetails) – (required) The details needed to update a project.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Project

Return type:

Response

update_task(workspace_id, task_key, update_task_details, **kwargs)

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.

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • task_key (str) – (required) DIS Task key
  • update_task_details (UpdateTaskDetails) – (required) The details needed to update a task.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Task

Return type:

Response

update_task_run(workspace_id, application_key, task_run_key, update_task_run_details, **kwargs)

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

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • application_key (str) – (required) DIS application key
  • task_run_key (str) – (required) DIS taskRun key
  • update_task_run_details (UpdateTaskRunDetails) – (required) The details needed to update the status of a task run.
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TaskRunDetails

Return type:

Response

update_workspace(workspace_id, update_workspace_details, **kwargs)

Updates the Data Integration Workspace

Parameters:
  • workspace_id (str) – (required) DIS workspace id
  • update_workspace_details (UpdateWorkspaceDetails) – (required) The information to be updated.
  • if_match (str) – (optional) Update and Delete operations should accept an optional If-Match header, in which clients can send a previously-received ETag. When If-Match is provided and its value does not exactly match the ETag of the resource on the server, the request should fail with HTTP response status code 412
  • opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Workspace

Return type:

Response