DataIntegrationClient¶

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

Use the Data Integration API to organize your data integration projects, create data flows, pipelines and tasks, and then publish, schedule, and run tasks that extract, transform, and load data. For more information, see [Data Integration](https://docs.oracle.com/iaas/data-integration/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_compartment`(workspace_id, …)	Moves a workspace to a specified compartment.
`change_dis_application_compartment`(…)	Moves a DIS Application to a specified compartment.
`create_application`(workspace_id, …)	Creates an application.
`create_application_detailed_description`(…)	Creates detailed description for an application.
`create_connection`(workspace_id, …)	Creates a connection under an existing data asset.
`create_connection_validation`(workspace_id, …)	Creates a connection validation.
`create_copy_object_request`(workspace_id, …)	Copy Metadata Object.
`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, …)	Accepts the data flow definition in the request payload and creates a data flow validation.
`create_dis_application`(workspace_id, …)	Creates a DIS Application.
`create_dis_application_detailed_description`(…)	Creates detailed description for an application.
`create_entity_shape`(workspace_id, …)	Creates the data entity shape using the shape from the data asset.
`create_export_request`(workspace_id, …)	Export Metadata Object
`create_external_publication`(workspace_id, …)	Publish a DataFlow in a OCI DataFlow application.
`create_external_publication_validation`(…)	Validates a specific task.
`create_folder`(workspace_id, …)	Creates a folder in a project or in another folder, limited to two levels of folders.
`create_function_library`(workspace_id, …)	Creates a function library in a project or in another function library, limited to two levels of function libraries.
`create_import_request`(workspace_id, …)	Import Metadata Object
`create_patch`(workspace_id, application_key, …)	Creates a patch in an application.
`create_pipeline`(workspace_id, …)	Creates a new pipeline in a project or folder ready for performing task orchestration.
`create_pipeline_validation`(workspace_id, …)	Accepts the data flow definition in the request payload and creates a pipeline validation.
`create_project`(workspace_id, …)	Creates a project.
`create_schedule`(workspace_id, …)	Endpoint to create a new schedule
`create_task`(workspace_id, …)	Creates a new task ready for performing data integrations.
`create_task_run`(workspace_id, …)	Creates a data integration task run for the specified task.
`create_task_schedule`(workspace_id, …)	Endpoint to be used create TaskSchedule.
`create_task_validation`(workspace_id, …)	Validates a specific task.
`create_user_defined_function`(workspace_id, …)	Creates a new UserDefinedFunction in a function library ready for performing data integrations.
`create_user_defined_function_validation`(…)	Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.
`create_workspace`(create_workspace_details, …)	Creates a new Data Integration workspace ready for performing data integration tasks.
`delete_application`(workspace_id, …)	Removes an application using the specified identifier.
`delete_application_detailed_description`(…)	Deletes detailed description of an Application.
`delete_connection`(workspace_id, …)	Removes a connection using the specified identifier.
`delete_connection_validation`(workspace_id, …)	Deletes a connection validation.
`delete_copy_object_request`(workspace_id, …)	Delete copy object request using the specified identifier.
`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_dis_application`(workspace_id, …)	Removes a DIS application using the specified identifier.
`delete_dis_application_detailed_description`(…)	Deletes detailed description of an Application.
`delete_export_request`(workspace_id, …)	Delete export object request using the specified identifier.
`delete_external_publication`(workspace_id, …)	Removes a published object using the specified identifier.
`delete_external_publication_validation`(…)	Removes a task validation using the specified identifier.
`delete_folder`(workspace_id, folder_key, **kwargs)	Removes a folder from a project using the specified identifier.
`delete_function_library`(workspace_id, …)	Removes a Function Library from a project using the specified identifier.
`delete_import_request`(import_request_key, …)	Delete import object request using the specified identifier.
`delete_patch`(workspace_id, application_key, …)	Removes a patch using the specified identifier.
`delete_pipeline`(workspace_id, pipeline_key, …)	Removes a pipeline from a project or folder using the specified identifier.
`delete_pipeline_validation`(workspace_id, …)	Removes a pipeline validation using the specified identifier.
`delete_project`(workspace_id, project_key, …)	Removes a project from the workspace using the specified identifier.
`delete_schedule`(workspace_id, …)	Endpoint to delete schedule.
`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_schedule`(workspace_id, …)	Endpoint to delete TaskSchedule.
`delete_task_validation`(workspace_id, …)	Removes a task validation using the specified identifier.
`delete_user_defined_function`(workspace_id, …)	Removes a UserDefinedFunction from a function library using the specified identifier.
`delete_user_defined_function_validation`(…)	Removes a UserDefinedFunction validation using the specified identifier.
`delete_workspace`(workspace_id, **kwargs)	Deletes a Data Integration workspace resource using the specified identifier.
`get_application`(workspace_id, …)	Retrieves an application using the specified identifier.
`get_application_detailed_description`(…)	Retrieves detailed description of an Application
`get_composite_state`(workspace_id, …)	This endpoint can be used to get composite state for a given aggregator
`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_copy_object_request`(workspace_id, …)	This endpoint can be used to get the summary/details of object being copied.
`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_dis_application`(workspace_id, …)	Retrieves an application using the specified OCID.
`get_dis_application_detailed_description`(…)	Retrieves detailed description of an Application.
`get_export_request`(workspace_id, …)	This endpoint can be used to get the summary/details of object being exported.
`get_external_publication`(workspace_id, …)	Retrieves a publshed object in an task using the specified identifier.
`get_external_publication_validation`(…)	Retrieves an external publication validation using the specified identifier.
`get_folder`(workspace_id, folder_key, **kwargs)	Retrieves a folder using the specified identifier.
`get_function_library`(workspace_id, …)	Retrieves a Function Library using the specified identifier.
`get_import_request`(workspace_id, …)	This endpoint can be used to get the summary/details of object being imported.
`get_patch`(workspace_id, application_key, …)	Retrieves a patch in an application using the specified identifier.
`get_pipeline`(workspace_id, pipeline_key, …)	Retrieves a pipeline using the specified identifier.
`get_pipeline_validation`(workspace_id, …)	Retrieves a pipeline validation 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_reference`(workspace_id, application_key, …)	Retrieves a reference in an application.
`get_runtime_operator`(workspace_id, …)	Retrieves a runtime operator using the specified identifier.
`get_runtime_pipeline`(workspace_id, …)	Retrieves a runtime pipeline using the specified identifier.
`get_schedule`(workspace_id, application_key, …)	Retrieves schedule by schedule key
`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_schedule`(workspace_id, …)	Endpoint used to get taskSchedule by its key
`get_task_validation`(workspace_id, …)	Retrieves a task validation using the specified identifier.
`get_template`(workspace_id, template_id, **kwargs)	This endpoint can be used to get an application template using a key.
`get_user_defined_function`(workspace_id, …)	Retrieves a UserDefinedFunction using the specified identifier.
`get_user_defined_function_validation`(…)	Retrieves a UserDefinedFunction validation using the specified identifier.
`get_work_request`(work_request_id, **kwargs)	Retrieves the status of the work request with the given ID.
`get_workspace`(workspace_id, **kwargs)	Retrieves a Data Integration workspace using the specified 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_copy_object_requests`(workspace_id, **kwargs)	This endpoint can be used to get the list of copy object requests.
`list_data_assets`(workspace_id, **kwargs)	Retrieves a list of all data asset summaries.
`list_data_entities`(workspace_id, …)	Lists a summary of data entities from the data asset using the specified connection.
`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_dis_application_task_run_lineages`(…)	This endpoint can be used to list Task Run Lineages within a given time window.
`list_dis_applications`(workspace_id, …)	Retrieves a list of DIS Applications in a compartment and provides options to filter the list.
`list_export_requests`(workspace_id, **kwargs)	This endpoint can be used to get the list of export object requests.
`list_external_publication_validations`(…)	Retrieves a lists of external publication validations in a workspace and provides options to filter the list.
`list_external_publications`(workspace_id, …)	Retrieves a list of external publications in an application and provides options to filter the list.
`list_folders`(workspace_id, **kwargs)	Retrieves a list of folders in a project and provides options to filter the list.
`list_function_libraries`(workspace_id, **kwargs)	Retrieves a list of function libraries in a project and provides options to filter the list.
`list_import_requests`(workspace_id, **kwargs)	This endpoint can be used to get the list of import object requests.
`list_patch_changes`(workspace_id, …)	Retrieves a list of patches in an application 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_pipeline_validations`(workspace_id, **kwargs)	Retrieves a list of pipeline validations within the specified workspace.
`list_pipelines`(workspace_id, **kwargs)	Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.
`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_references`(workspace_id, …)	Retrieves a list of references in an application.
`list_runtime_operators`(workspace_id, …)	This endpoint can be used to list runtime operators with filtering options
`list_runtime_pipelines`(workspace_id, …)	This endpoint can be used to list runtime pipelines with filtering options
`list_schedules`(workspace_id, …)	Use this endpoint to list schedules.
`list_schemas`(workspace_id, connection_key, …)	Retrieves a list of all the schemas that can be accessed using the specified connection.
`list_task_run_lineages`(workspace_id, …)	This endpoint can be used to list Task Run Lineages within a given time window.
`list_task_run_logs`(workspace_id, …)	Gets 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_schedules`(workspace_id, …)	This endpoint can be used to get the list of all the TaskSchedule objects.
`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_templates`(workspace_id, **kwargs)	This endpoint can be used to list application templates with filtering options.
`list_user_defined_function_validations`(…)	Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.
`list_user_defined_functions`(workspace_id, …)	Retrieves a list of UserDefinedFunctions in a function library.
`list_work_request_errors`(work_request_id, …)	Retrieves a paginated list of errors for a given work request.
`list_work_request_logs`(work_request_id, **kwargs)	Retrieves 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)	Retrieves a list of Data Integration workspaces.
`start_workspace`(workspace_id, **kwargs)	Starts a workspace.
`stop_workspace`(workspace_id, **kwargs)	Stops a workspace.
`update_application`(workspace_id, …)	Updates an application.
`update_application_detailed_description`(…)	Updates the detailed description of an Application.
`update_connection`(workspace_id, …)	Updates a connection under a data asset.
`update_copy_object_request`(workspace_id, …)	Updates the status of a copy object request.
`update_data_asset`(workspace_id, …)	Updates a specific data asset with default connection.
`update_data_flow`(workspace_id, …)	Updates a specific data flow.
`update_dis_application`(workspace_id, …)	Updates a DIS Application.
`update_dis_application_detailed_description`(…)	Updates the detailed description of an Application.
`update_export_request`(workspace_id, …)	Updates the status of a export object request.
`update_external_publication`(workspace_id, …)	Updates the external publication object.
`update_folder`(workspace_id, folder_key, …)	Updates a specific folder.
`update_function_library`(workspace_id, …)	Updates a specific Function Library.
`update_import_request`(workspace_id, …)	Updates the status of a import object request.
`update_pipeline`(workspace_id, pipeline_key, …)	Updates a specific pipeline.
`update_project`(workspace_id, project_key, …)	Updates a specific project.
`update_reference`(workspace_id, …)	Updates the application references.
`update_schedule`(workspace_id, …)	Endpoint used to update the schedule
`update_task`(workspace_id, task_key, …)	Updates a specific task.
`update_task_run`(workspace_id, …)	Updates the status of the task run.
`update_task_schedule`(workspace_id, …)	Endpoint used to update the TaskSchedule
`update_user_defined_function`(workspace_id, …)	Updates a specific UserDefinedFunction.
`update_workspace`(workspace_id, …)	Updates the specified 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.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_compartment(workspace_id, change_compartment_details, **kwargs)¶

Moves a workspace to a specified compartment.

Parameters:	workspace_id (str) – (required) The workspace ID. change_compartment_details (oci.data_integration.models.ChangeCompartmentDetails) – (required) The information needed to move a workspace to a specified compartment. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

change_dis_application_compartment(workspace_id, dis_application_id, change_dis_application_compartment_details, **kwargs)¶

Moves a DIS Application to a specified compartment.

Parameters:	workspace_id (str) – (required) The workspace ID. dis_application_id (str) – (required) The OCID of the DIS Application. change_dis_application_compartment_details (oci.data_integration.models.ChangeDisApplicationCompartmentDetails) – (required) The information needed to move a DIS Application to a specified compartment. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

create_application(workspace_id, create_application_details, **kwargs)¶

Creates an application.

Parameters:	workspace_id (str) – (required) The workspace ID. create_application_details (oci.data_integration.models.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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Application`
Return type:	`Response`
Example:

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

create_application_detailed_description(workspace_id, application_key, create_application_detailed_description_details, **kwargs)¶

Creates detailed description for an application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. create_application_detailed_description_details (oci.data_integration.models.CreateDetailedDescriptionDetails) – (required) Detailed description of 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DetailedDescription`
Return type:	`Response`
Example:

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

create_connection(workspace_id, create_connection_details, **kwargs)¶

Creates a connection under an existing data asset.

Parameters:	workspace_id (str) – (required) The workspace ID. create_connection_details (oci.data_integration.models.CreateConnectionDetails) – (required) The information needed to create a connection. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

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

create_connection_validation(workspace_id, create_connection_validation_details, **kwargs)¶

Creates a connection validation.

Parameters:	workspace_id (str) – (required) The workspace ID. create_connection_validation_details (oci.data_integration.models.CreateConnectionValidationDetails) – (required) The information needed to validate a connection. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionValidation`
Return type:	`Response`
Example:

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

create_copy_object_request(workspace_id, create_copy_object_request_details, **kwargs)¶

Copy Metadata Object.

Parameters:	workspace_id (str) – (required) The workspace ID. create_copy_object_request_details (oci.data_integration.models.CreateCopyObjectRequestDetails) – (required) The details needed to copy metadata 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CopyObjectRequest`
Return type:	`Response`
Example:

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

create_data_asset(workspace_id, create_data_asset_details, **kwargs)¶

Creates a data asset with default connection.

Parameters:	workspace_id (str) – (required) The workspace ID. create_data_asset_details (oci.data_integration.models.CreateDataAssetDetails) – (required) The information needed to create a data asset. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

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

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) The workspace ID. create_data_flow_details (oci.data_integration.models.CreateDataFlowDetails) – (required) The details needed to create a new data flow. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlow`
Return type:	`Response`
Example:

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

create_data_flow_validation(workspace_id, create_data_flow_validation_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. create_data_flow_validation_details (oci.data_integration.models.CreateDataFlowValidationDetails) – (required) The information needed to create the data flow validation for the data flow 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlowValidation`
Return type:	`Response`
Example:

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

create_dis_application(workspace_id, create_dis_application_details, **kwargs)¶

Creates a DIS Application.

Parameters:	workspace_id (str) – (required) The workspace ID. create_dis_application_details (oci.data_integration.models.CreateDisApplicationDetails) – (required) The details needed to create a DIS 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DisApplication`
Return type:	`Response`
Example:

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

create_dis_application_detailed_description(workspace_id, application_key, create_dis_application_detailed_description_details, **kwargs)¶

Creates detailed description for an application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. create_dis_application_detailed_description_details (oci.data_integration.models.CreateDetailedDescriptionDetails) – (required) Detailed description of 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DetailedDescription`
Return type:	`Response`
Example:

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

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

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

Parameters:	workspace_id (str) – (required) The workspace ID. connection_key (str) – (required) The connection key. schema_resource_name (str) – (required) The schema resource name used for retrieving schemas. create_entity_shape_details (oci.data_integration.models.CreateEntityShapeDetails) – (required) The details needed to create 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `EntityShape`
Return type:	`Response`
Example:

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

create_export_request(workspace_id, create_export_request_details, **kwargs)¶

Export Metadata Object

Parameters:	workspace_id (str) – (required) The workspace ID. create_export_request_details (oci.data_integration.models.CreateExportRequestDetails) – (required) The details needed to export metadata 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExportRequest`
Return type:	`Response`
Example:

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

create_external_publication(workspace_id, task_key, create_external_publication_details, **kwargs)¶

Publish a DataFlow in a OCI DataFlow application.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. create_external_publication_details (oci.data_integration.models.CreateExternalPublicationDetails) – (required) Details needed to publish a task to OCI DataFlow 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublication`
Return type:	`Response`
Example:

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

create_external_publication_validation(workspace_id, task_key, create_external_publication_validation_details, **kwargs)¶

Validates a specific task.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. create_external_publication_validation_details (oci.data_integration.models.CreateExternalPublicationValidationDetails) – (required) The information needed to create a 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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublicationValidation`
Return type:	`Response`
Example:

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

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) The workspace ID. create_folder_details (oci.data_integration.models.CreateFolderDetails) – (required) The details needed to create a folder. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Folder`
Return type:	`Response`
Example:

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

create_function_library(workspace_id, create_function_library_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. create_function_library_details (oci.data_integration.models.CreateFunctionLibraryDetails) – (required) The details needed to create a function Library. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FunctionLibrary`
Return type:	`Response`
Example:

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

create_import_request(workspace_id, create_import_request_details, **kwargs)¶

Import Metadata Object

Parameters:	workspace_id (str) – (required) The workspace ID. create_import_request_details (oci.data_integration.models.CreateImportRequestDetails) – (required) The details needed to import metadata 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportRequest`
Return type:	`Response`
Example:

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

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

Creates a patch in an application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. create_patch_details (oci.data_integration.models.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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Patch`
Return type:	`Response`
Example:

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

create_pipeline(workspace_id, create_pipeline_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. create_pipeline_details (oci.data_integration.models.CreatePipelineDetails) – (required) The details needed to create a new pipeline. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Pipeline`
Return type:	`Response`
Example:

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

create_pipeline_validation(workspace_id, create_pipeline_validation_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. create_pipeline_validation_details (oci.data_integration.models.CreatePipelineValidationDetails) – (required) The information needed to create the data flow validation for the pipeline 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PipelineValidation`
Return type:	`Response`
Example:

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

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) The workspace ID. create_project_details (oci.data_integration.models.CreateProjectDetails) – (required) The details needed to create a project in a workspace. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Project`
Return type:	`Response`
Example:

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

create_schedule(workspace_id, application_key, create_schedule_details, **kwargs)¶

Endpoint to create a new schedule

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. create_schedule_details (oci.data_integration.models.CreateScheduleDetails) – (required) Request body parameter for Schedule 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Schedule`
Return type:	`Response`
Example:

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

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) The workspace ID. create_task_details (oci.data_integration.models.CreateTaskDetails) – (required) The details needed to create a new task. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Task`
Return type:	`Response`
Example:

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

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

Creates a data integration task run for the specified task.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. create_task_run_details (oci.data_integration.models.CreateTaskRunDetails) – (required) The details needed to create a task run. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskRun`
Return type:	`Response`
Example:

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

create_task_schedule(workspace_id, application_key, create_task_schedule_details, **kwargs)¶

Endpoint to be used create TaskSchedule.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. create_task_schedule_details (oci.data_integration.models.CreateTaskScheduleDetails) – (required) Request body parameter for TaskSchedule 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskSchedule`
Return type:	`Response`
Example:

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

create_task_validation(workspace_id, create_task_validation_details, **kwargs)¶

Validates a specific task.

Parameters:	workspace_id (str) – (required) The workspace ID. create_task_validation_details (oci.data_integration.models.CreateTaskValidationDetails) – (required) The information needed to create a 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. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskValidation`
Return type:	`Response`
Example:

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

create_user_defined_function(workspace_id, create_user_defined_function_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. create_user_defined_function_details (oci.data_integration.models.CreateUserDefinedFunctionDetails) – (required) The details needed to create a new UserDefinedFunction. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunction`
Return type:	`Response`
Example:

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

create_user_defined_function_validation(workspace_id, create_user_defined_function_validation_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. create_user_defined_function_validation_details (oci.data_integration.models.CreateUserDefinedFunctionValidationDetails) – (required) The information needed to create the UserDefinedFunction validation for the UserDefinedFunction 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunctionValidation`
Return type:	`Response`
Example:

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

create_workspace(create_workspace_details, **kwargs)¶

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

Parameters:	create_workspace_details (oci.data_integration.models.CreateWorkspaceDetails) – (required) The information needed to create a new Data Integration workspace. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_application(workspace_id, application_key, **kwargs)¶

Removes an application using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_application_detailed_description(workspace_id, application_key, **kwargs)¶

Deletes detailed description of an Application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_connection(workspace_id, connection_key, **kwargs)¶

Removes a connection using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. connection_key (str) – (required) The connection key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_connection_validation(workspace_id, connection_validation_key, **kwargs)¶

Deletes a connection validation.

Parameters:	workspace_id (str) – (required) The workspace ID. connection_validation_key (str) – (required) The key of the connection validation. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_copy_object_request(workspace_id, copy_object_request_key, **kwargs)¶

Delete copy object request using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. copy_object_request_key (str) – (required) The key of the object to be copied, for example this could be the key of 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_data_asset(workspace_id, data_asset_key, **kwargs)¶

Removes a data asset using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. data_asset_key (str) – (required) The data asset key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

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) The workspace ID. data_flow_key (str) – (required) The data flow key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

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) The workspace ID. data_flow_validation_key (str) – (required) The key of the dataflow validation. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_dis_application(workspace_id, dis_application_id, **kwargs)¶

Removes a DIS application using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. dis_application_id (str) – (required) The OCID of the DIS Application. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_dis_application_detailed_description(workspace_id, application_key, **kwargs)¶

Deletes detailed description of an Application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_export_request(workspace_id, export_request_key, **kwargs)¶

Delete export object request using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. export_request_key (str) – (required) The key of the object export object 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_publication(workspace_id, task_key, external_publications_key, **kwargs)¶

Removes a published object using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. external_publications_key (str) – (required) The external published object key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_external_publication_validation(workspace_id, task_key, external_publication_validation_key, **kwargs)¶

Removes a task validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. external_publication_validation_key (str) – (required) The external published object key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_folder(workspace_id, folder_key, **kwargs)¶

Removes a folder from a project using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. folder_key (str) – (required) The folder key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_function_library(workspace_id, function_library_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. function_library_key (str) – (required) The functionLibrary key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_import_request(import_request_key, workspace_id, **kwargs)¶

Delete import object request using the specified identifier.

Parameters:	import_request_key (str) – (required) The key of the object export object request workspace_id (str) – (required) The 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

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

Removes a patch using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. patch_key (str) – (required) The patch key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_pipeline(workspace_id, pipeline_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. pipeline_key (str) – (required) The pipeline key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_pipeline_validation(workspace_id, pipeline_validation_key, **kwargs)¶

Removes a pipeline validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. pipeline_validation_key (str) – (required) The key of the pipeline validation. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_project(workspace_id, project_key, **kwargs)¶

Removes a project from the workspace using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. project_key (str) – (required) The project key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_schedule(workspace_id, application_key, schedule_key, **kwargs)¶

Endpoint to delete schedule.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. schedule_key (str) – (required) Schedule Key if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_task(workspace_id, task_key, **kwargs)¶

Removes a task using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

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

Deletes a task run using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. task_run_key (str) – (required) The task run key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_task_schedule(workspace_id, application_key, task_schedule_key, **kwargs)¶

Endpoint to delete TaskSchedule.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. task_schedule_key (str) – (required) TaskSchedule Key if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_task_validation(workspace_id, task_validation_key, **kwargs)¶

Removes a task validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_validation_key (str) – (required) The task validation key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_user_defined_function(workspace_id, user_defined_function_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. user_defined_function_key (str) – (required) The user defined function key. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_user_defined_function_validation(workspace_id, user_defined_function_validation_key, **kwargs)¶

Removes a UserDefinedFunction validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. user_defined_function_validation_key (str) – (required) The key of the userDefinedFunction validation. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

delete_workspace(workspace_id, **kwargs)¶

Deletes a Data Integration workspace resource using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. quiesce_timeout (int) – (optional) Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace. is_force_operation (bool) – (optional) Used to force close down the workspace. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

get_application(workspace_id, application_key, **kwargs)¶

Retrieves an application using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Application`
Return type:	`Response`
Example:

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

get_application_detailed_description(workspace_id, application_key, **kwargs)¶

Retrieves detailed description of an Application

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DetailedDescription`
Return type:	`Response`
Example:

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

get_composite_state(workspace_id, application_key, aggregator_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. aggregator_key (str) – (required) Unique key of the aggregator for which we want to get the Composite State 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CompositeState`
Return type:	`Response`
Example:

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

get_connection(workspace_id, connection_key, **kwargs)¶

Retrieves the connection details using the specified identifier.

Parameters:	workspace_id (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

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

get_connection_validation(workspace_id, connection_validation_key, **kwargs)¶

Retrieves a connection validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. connection_validation_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionValidation`
Return type:	`Response`
Example:

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

get_copy_object_request(workspace_id, copy_object_request_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. copy_object_request_key (str) – (required) The key of the object to be copied, for example this could be the key of 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. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CopyObjectRequest`
Return type:	`Response`
Example:

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

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) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CountStatistic`
Return type:	`Response`
Example:

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

get_data_asset(workspace_id, data_asset_key, **kwargs)¶

Retrieves details of a data asset using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. data_asset_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

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

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) The workspace ID. connection_key (str) – (required) The connection key. schema_resource_name (str) – (required) The schema resource name used for retrieving schemas. data_entity_key (str) – (required) The key 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataEntity`
Return type:	`Response`
Example:

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

get_data_flow(workspace_id, data_flow_key, **kwargs)¶

Retrieves a data flow using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. data_flow_key (str) – (required) The data flow 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) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlow`
Return type:	`Response`
Example:

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

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) The workspace ID. data_flow_validation_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlowValidation`
Return type:	`Response`
Example:

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

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) The workspace ID. application_key (str) – (required) The application key. dependent_object_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DependentObject`
Return type:	`Response`
Example:

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

get_dis_application(workspace_id, dis_application_id, **kwargs)¶

Retrieves an application using the specified OCID.

Parameters:	workspace_id (str) – (required) The workspace ID. dis_application_id (str) – (required) The OCID of the DIS 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. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DisApplication`
Return type:	`Response`
Example:

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

get_dis_application_detailed_description(workspace_id, application_key, **kwargs)¶

Retrieves detailed description of an Application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DetailedDescription`
Return type:	`Response`
Example:

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

get_export_request(workspace_id, export_request_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. export_request_key (str) – (required) The key of the object export object 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExportRequest`
Return type:	`Response`
Example:

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

get_external_publication(workspace_id, task_key, external_publications_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. external_publications_key (str) – (required) The external 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. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublication`
Return type:	`Response`
Example:

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

get_external_publication_validation(workspace_id, task_key, external_publication_validation_key, **kwargs)¶

Retrieves an external publication validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. external_publication_validation_key (str) – (required) The external 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. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublicationValidation`
Return type:	`Response`
Example:

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

get_folder(workspace_id, folder_key, **kwargs)¶

Retrieves a folder using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. folder_key (str) – (required) The 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. projection (list[str]) – (optional) This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. Allowed values are: “CHILD_COUNT_STATISTICS” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Folder`
Return type:	`Response`
Example:

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

get_function_library(workspace_id, function_library_key, **kwargs)¶

Retrieves a Function Library using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. function_library_key (str) – (required) The functionLibrary 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. projection (list[str]) – (optional) This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. Allowed values are: “CHILD_COUNT_STATISTICS” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FunctionLibrary`
Return type:	`Response`
Example:

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

get_import_request(workspace_id, import_request_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. import_request_key (str) – (required) The key of the object export object 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. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportRequest`
Return type:	`Response`
Example:

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

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

Retrieves a patch in an application using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. patch_key (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Patch`
Return type:	`Response`
Example:

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

get_pipeline(workspace_id, pipeline_key, **kwargs)¶

Retrieves a pipeline using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. pipeline_key (str) – (required) The pipeline 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) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Pipeline`
Return type:	`Response`
Example:

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

get_pipeline_validation(workspace_id, pipeline_validation_key, **kwargs)¶

Retrieves a pipeline validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. pipeline_validation_key (str) – (required) The key of the pipeline 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PipelineValidation`
Return type:	`Response`
Example:

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

get_project(workspace_id, project_key, **kwargs)¶

Retrieves a project using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. project_key (str) – (required) The 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. projection (list[str]) – (optional) This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. Allowed values are: “CHILD_COUNT_STATISTICS” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Project`
Return type:	`Response`
Example:

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

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) The workspace ID. application_key (str) – (required) The application key. published_object_key (str) – (required) The 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) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PublishedObject`
Return type:	`Response`
Example:

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

get_reference(workspace_id, application_key, reference_key, **kwargs)¶

Retrieves a reference in an application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. reference_key (str) – (required) The reference 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Reference`
Return type:	`Response`
Example:

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

get_runtime_operator(workspace_id, application_key, runtime_pipeline_key, runtime_operator_key, **kwargs)¶

Retrieves a runtime operator using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. runtime_pipeline_key (str) – (required) Runtime Pipeline Key runtime_operator_key (str) – (required) Runtime Operator 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RuntimeOperator`
Return type:	`Response`
Example:

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

get_runtime_pipeline(workspace_id, application_key, runtime_pipeline_key, **kwargs)¶

Retrieves a runtime pipeline using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. runtime_pipeline_key (str) – (required) Runtime Pipeline 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) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RuntimePipeline`
Return type:	`Response`
Example:

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

get_schedule(workspace_id, application_key, schedule_key, **kwargs)¶

Retrieves schedule by schedule key

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. schedule_key (str) – (required) Schedule 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Schedule`
Return type:	`Response`
Example:

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

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) The workspace ID. connection_key (str) – (required) The connection key. schema_resource_name (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Schema`
Return type:	`Response`
Example:

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

get_task(workspace_id, task_key, **kwargs)¶

Retrieves a task using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The 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. expand_references (str) – (optional) Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false. <br><br><B>Example:</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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Task`
Return type:	`Response`
Example:

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

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

Retrieves a task run using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. task_run_key (str) – (required) The task run 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskRun`
Return type:	`Response`
Example:

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

get_task_schedule(workspace_id, application_key, task_schedule_key, **kwargs)¶

Endpoint used to get taskSchedule by its key

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. task_schedule_key (str) – (required) TaskSchedule 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskSchedule`
Return type:	`Response`
Example:

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

get_task_validation(workspace_id, task_validation_key, **kwargs)¶

Retrieves a task validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. task_validation_key (str) – (required) The task validation 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskValidation`
Return type:	`Response`
Example:

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

get_template(workspace_id, template_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. template_id (str) – (required) The OCID of the template. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Template`
Return type:	`Response`
Example:

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

get_user_defined_function(workspace_id, user_defined_function_key, **kwargs)¶

Retrieves a UserDefinedFunction using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. user_defined_function_key (str) – (required) The user defined function 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunction`
Return type:	`Response`
Example:

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

get_user_defined_function_validation(workspace_id, user_defined_function_validation_key, **kwargs)¶

Retrieves a UserDefinedFunction validation using the specified identifier.

Parameters:	workspace_id (str) – (required) The workspace ID. user_defined_function_validation_key (str) – (required) The key of the userDefinedFunction 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunctionValidation`
Return type:	`Response`
Example:

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

get_work_request(work_request_id, **kwargs)¶

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

Parameters:	work_request_id (str) – (required) The ID of the asynchronous work request to retrieve. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

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

get_workspace(workspace_id, **kwargs)¶

Retrieves a Data Integration workspace using the specified identifier.

Parameters:	workspace_id (str) – (required) The 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Workspace`
Return type:	`Response`
Example:

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

list_applications(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. name (str) – (optional) Used to filter by the name of the object. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. identifier (list[str]) – (optional) Used to filter by the identifier of the published object. fields (list[str]) – (optional) Specifies the fields to get for an object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ApplicationSummaryCollection`
Return type:	`Response`
Example:

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

list_connection_validations(workspace_id, **kwargs)¶

Retrieves a list of connection validations within the specified workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. key (str) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (str) – (optional) Used to filter by the identifier of the object. fields (list[str]) – (optional) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionValidationSummaryCollection`
Return type:	`Response`
Example:

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

list_connections(workspace_id, data_asset_key, **kwargs)¶

Retrieves a list of all connections.

Parameters:	workspace_id (str) – (required) The workspace ID. data_asset_key (str) – (required) Used to filter by the data asset key of the object. name (str) – (optional) Used to filter by the name of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. fields (list[str]) – (optional) Specifies the fields to get for an object. type (str) – (optional) Type of the object to filter the results with. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionSummaryCollection`
Return type:	`Response`
Example:

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

list_copy_object_requests(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. name (str) – (optional) Used to filter by the name of the object. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” copy_status (str) – (optional) Specifies copy status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . Allowed values are: “IN_PROGRESS”, “SUCCESSFUL”, “QUEUED”, “TERMINATING”, “TERMINATED”, “FAILED”, “ALL” projection (str) – (optional) This parameter allows users to specify which view of the copy object response to return. SUMMARY - Summary of the copy object response will be returned. This is the default option when no value is specified. DETAILS - Details of copy object response will be returned. This will include details of all the objects to be copied. Allowed values are: “SUMMARY”, “DETAILS” time_started_in_millis (int) – (optional) Specifies start time of a copy object request. time_ended_in_millis (int) – (optional) Specifies end time of a copy object request. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CopyObjectRequestSummaryCollection`
Return type:	`Response`
Example:

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

list_data_assets(workspace_id, **kwargs)¶

Retrieves a list of all data asset summaries.

Parameters:	workspace_id (str) – (required) The workspace ID. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. fields (list[str]) – (optional) Specifies the fields to get for an object. type (str) – (optional) Type of the object to filter the results with. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” name (str) – (optional) 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAssetSummaryCollection`
Return type:	`Response`
Example:

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

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

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

Parameters:	workspace_id (str) – (required) The workspace ID. connection_key (str) – (required) The connection key. schema_resource_name (str) – (required) The schema resource name used for retrieving schemas. name (str) – (optional) Used to filter by the name of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. type (str) – (optional) Type of the object to filter the results with. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. fields (list[str]) – (optional) Specifies the fields to get for an object. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. name_list (list[str]) – (optional) Used to filter by the name of the object. is_pattern (bool) – (optional) This parameter can be used to specify whether entity search type is pattern search or not. include_types (list[str]) – (optional) Artifact type which needs to be listed while listing Artifacts. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataEntitySummaryCollection`
Return type:	`Response`
Example:

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

list_data_flow_validations(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. key (str) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (str) – (optional) Used to filter by the identifier of the object. fields (list[str]) – (optional) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlowValidationSummaryCollection`
Return type:	`Response`
Example:

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

list_data_flows(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlowSummaryCollection`
Return type:	`Response`
Example:

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

list_dependent_objects(workspace_id, application_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. identifier (list[str]) – (optional) Used to filter by the identifier of the published object. type (list[str]) – (optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used. type_in_subtree (str) – (optional) 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) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DependentObjectSummaryCollection`
Return type:	`Response`
Example:

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

list_dis_application_task_run_lineages(workspace_id, dis_application_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. dis_application_id (str) – (required) The OCID of the DIS 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. fields (list[str]) – (optional) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” filter (list[str]) – (optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul> time_updated_greater_than (datetime) – (optional) This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” time_updated_greater_than_or_equal_to (datetime) – (optional) This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” time_upated_less_than (datetime) – (optional) This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” time_upated_less_than_or_equal_to (datetime) – (optional) This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskRunLineageSummaryCollection`
Return type:	`Response`
Example:

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

list_dis_applications(workspace_id, compartment_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. compartment_id (str) – (required) OCID of the compartment for which the list of DIS Applications is to be retrieved. name (str) – (optional) Used to filter by the name of the object. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. identifier (list[str]) – (optional) Used to filter by the identifier of the published object. fields (list[str]) – (optional) Specifies the fields to get for an object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DisApplicationSummaryCollection`
Return type:	`Response`
Example:

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

list_export_requests(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. name (str) – (optional) Used to filter by the name of the object. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” export_status (str) – (optional) Specifies export status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . Allowed values are: “IN_PROGRESS”, “SUCCESSFUL”, “QUEUED”, “TERMINATING”, “TERMINATED”, “FAILED” projection (str) – (optional) This parameter allows users to specify which view of the export object response to return. SUMMARY - Summary of the export object request will be returned. This is the default option when no value is specified. DETAILS - Details of export object request will be returned. This will include details of all the objects to be exported. Allowed values are: “SUMMARY”, “DETAILS” time_started_in_millis (int) – (optional) Specifies start time of a copy object request. time_ended_in_millis (int) – (optional) Specifies end time of a copy object request. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExportRequestSummaryCollection`
Return type:	`Response`
Example:

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

list_external_publication_validations(workspace_id, task_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The 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. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublicationValidationSummaryCollection`
Return type:	`Response`
Example:

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

list_external_publications(workspace_id, task_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublicationSummaryCollection`
Return type:	`Response`
Example:

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

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) The 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) Used to filter by the project or the folder object. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FolderSummaryCollection`
Return type:	`Response`
Example:

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

list_function_libraries(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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) Used to filter by the project or the folder object. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FunctionLibrarySummaryCollection`
Return type:	`Response`
Example:

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

list_import_requests(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. name (str) – (optional) Used to filter by the name of the object. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” import_status (str) – (optional) Specifies import status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . Allowed values are: “IN_PROGRESS”, “SUCCESSFUL”, “QUEUED”, “TERMINATING”, “TERMINATED”, “FAILED” projection (str) – (optional) This parameter allows users to specify which view of the import object response to return. SUMMARY - Summary of the import object request will be returned. This is the default option when no value is specified. DETAILS - Details of import object request will be returned. This will include details of all the objects to be exported. Allowed values are: “SUMMARY”, “DETAILS” time_started_in_millis (int) – (optional) Specifies start time of a copy object request. time_ended_in_millis (int) – (optional) Specifies end time of a copy object request. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportRequestSummaryCollection`
Return type:	`Response`
Example:

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

list_patch_changes(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) The workspace ID. application_key (str) – (required) The application key. name (str) – (optional) Used to filter by the name of the object. since_patch (str) – (optional) Specifies the patch key to query from. to_patch (str) – (optional) Specifies the patch key to query to. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PatchChangeSummaryCollection`
Return type:	`Response`
Example:

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

list_patches(workspace_id, application_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the published object. fields (list[str]) – (optional) Specifies the fields to get for an object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PatchSummaryCollection`
Return type:	`Response`
Example:

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

list_pipeline_validations(workspace_id, **kwargs)¶

Retrieves a list of pipeline validations within the specified workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. key (str) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (str) – (optional) Used to filter by the identifier of the object. fields (list[str]) – (optional) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PipelineValidationSummaryCollection`
Return type:	`Response`
Example:

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

list_pipelines(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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) Used to filter by the project or the folder object. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PipelineSummaryCollection`
Return type:	`Response`
Example:

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

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) The 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) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ProjectSummaryCollection`
Return type:	`Response`
Example:

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

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) The workspace ID. application_key (str) – (required) The application key. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. name_starts_with (str) – (optional) This parameter can be used to filter objects by the names starting with the given value. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. identifier (list[str]) – (optional) Used to filter by the identifier of the published object. type (list[str]) – (optional) Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used. type_in_subtree (str) – (optional) 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) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PublishedObjectSummaryCollection`
Return type:	`Response`
Example:

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

list_references(workspace_id, application_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The 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. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. name (str) – (optional) Used to filter by the name of the object. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ReferenceSummaryCollection`
Return type:	`Response`
Example:

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

list_runtime_operators(workspace_id, application_key, runtime_pipeline_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. runtime_pipeline_key (str) – (required) Runtime Pipeline 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. key (list[str]) – (optional) Used to filter by the key of the object. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” aggregator_type (list[str]) – (optional) Unique type of the aggregator 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RuntimeOperatorSummaryCollection`
Return type:	`Response`
Example:

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

list_runtime_pipelines(workspace_id, application_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The 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. key (list[str]) – (optional) Used to filter by the key of the object. aggregator_key (str) – (optional) Unique key of the aggregator fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” aggregator_type (list[str]) – (optional) Unique type of the aggregator filter (list[str]) – (optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `RuntimePipelineSummaryCollection`
Return type:	`Response`
Example:

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

list_schedules(workspace_id, application_key, **kwargs)¶

Use this endpoint to list schedules.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. key (list[str]) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. type (list[str]) – (optional) Used to filter by the object type of the object. It 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> page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ScheduleSummaryCollection`
Return type:	`Response`
Example:

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

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) The workspace ID. connection_key (str) – (required) The connection key. schema_resource_name (str) – (required) Schema resource name used for retrieving schemas. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. fields (list[str]) – (optional) Specifies the fields to get for an object. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” name (str) – (optional) 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. name_list (list[str]) – (optional) Used to filter by the name of the object. include_types (list[str]) – (optional) Artifact type which needs to be listed while listing Artifacts. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SchemaSummaryCollection`
Return type:	`Response`
Example:

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

list_task_run_lineages(workspace_id, application_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The 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) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” filter (list[str]) – (optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul> time_updated_greater_than (datetime) – (optional) This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” time_updated_greater_than_or_equal_to (datetime) – (optional) This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” time_upated_less_than (datetime) – (optional) This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” time_upated_less_than_or_equal_to (datetime) – (optional) This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is “YYYY-MM-dd’T’HH:mm:ss.SSS’Z’” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskRunLineageSummaryCollection`
Return type:	`Response`
Example:

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

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

Gets log entries for task runs using its key.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. task_run_key (str) – (required) The task run 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) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `TaskRunLogSummary`
Return type:	`Response`
Example:

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

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) The workspace ID. application_key (str) – (required) The 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. key (list[str]) – (optional) Used to filter by the key of the object. aggregator_key (str) – (optional) Used to filter by the project or the folder object. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” filter (list[str]) – (optional) This filter parameter can be used to filter by model specific queryable fields of the object <br><br><B>Examples:-</B><br> <ul> <li><B>?filter=status eq Failed</B> returns all objects that have a status field with value Failed</li> </ul> name_starts_with (str) – (optional) This parameter can be used to filter objects by the names starting with the given value. name_contains (str) – (optional) This parameter can be used to filter objects by the names that match partially or fully with the given value. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskRunSummaryCollection`
Return type:	`Response`
Example:

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

list_task_schedules(workspace_id, application_key, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. key (list[str]) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. type (list[str]) – (optional) Used to filter by the object type of the object. It 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> page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. is_enabled (bool) – (optional) This filter parameter can be used to filter task schedule by its state. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskScheduleSummaryCollection`
Return type:	`Response`
Example:

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

list_task_validations(workspace_id, **kwargs)¶

Retrieves a list of task validations within the specified workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. key (str) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (str) – (optional) Used to filter by the identifier of the object. fields (list[str]) – (optional) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskValidationSummaryCollection`
Return type:	`Response`
Example:

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

list_tasks(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The 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) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. key (list[str]) – (optional) Used to filter by the key of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. type (list[str]) – (optional) Used to filter by the object type of the object. It 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) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskSummaryCollection`
Return type:	`Response`
Example:

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

list_templates(workspace_id, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the published object. fields (list[str]) – (optional) Specifies the fields to get for an object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TemplateSummaryCollection`
Return type:	`Response`
Example:

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

list_user_defined_function_validations(workspace_id, **kwargs)¶

Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. key (str) – (optional) Used to filter by the key of the object. name (str) – (optional) Used to filter by the name of the object. identifier (str) – (optional) Used to filter by the identifier of the object. fields (list[str]) – (optional) Specifies the fields to get for an object. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunctionValidationSummaryCollection`
Return type:	`Response`
Example:

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

list_user_defined_functions(workspace_id, **kwargs)¶

Retrieves a list of UserDefinedFunctions in a function library.

Parameters:	workspace_id (str) – (required) The 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. function_library_key (str) – (optional) Unique key of the FunctionLibrary. fields (list[str]) – (optional) Specifies the fields to get for an object. name (str) – (optional) Used to filter by the name of the object. identifier (list[str]) – (optional) Used to filter by the identifier of the object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunctionSummaryCollection`
Return type:	`Response`
Example:

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

list_work_request_errors(work_request_id, **kwargs)¶

Retrieves a paginated list of errors for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous work request to retrieve. 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) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestError`
Return type:	`Response`
Example:

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

list_work_request_logs(work_request_id, **kwargs)¶

Retrieves a paginated list of logs for a given work request.

Parameters:	work_request_id (str) – (required) The ID of the asynchronous work request to retrieve. 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) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestLogEntry`
Return type:	`Response`
Example:

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

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the resources you want to list. 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. workspace_id (str) – (optional) DIS workspace id work_request_status (str) – (optional) The work request status. Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED” page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestSummary`
Return type:	`Response`
Example:

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

list_workspaces(compartment_id, **kwargs)¶

Retrieves a list of Data Integration workspaces.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the resources you want to list. name (str) – (optional) Used to filter by the name of the object. limit (int) – (optional) Sets the maximum number of results per page, or items to return in a paginated List call. See List Pagination. page (str) – (optional) For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See List Pagination. lifecycle_state (str) – (optional) The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “STARTING”, “STOPPING”, “STOPPED” sort_order (str) – (optional) Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. 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”, “TIME_UPDATED” 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkspaceSummary`
Return type:	`Response`
Example:

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

start_workspace(workspace_id, **kwargs)¶

Starts a workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

stop_workspace(workspace_id, **kwargs)¶

Stops a workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. quiesce_timeout (int) – (optional) Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace. is_force_operation (bool) – (optional) Used to force close down the workspace. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

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

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

Updates an application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. update_application_details (oci.data_integration.models.UpdateApplicationDetails) – (required) The details needed to update an application. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Application`
Return type:	`Response`
Example:

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

update_application_detailed_description(workspace_id, application_key, update_application_detailed_description_details, **kwargs)¶

Updates the detailed description of an Application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. update_application_detailed_description_details (oci.data_integration.models.UpdateDetailedDescriptionDetails) – (required) The details needed to update the detailed description of 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DetailedDescription`
Return type:	`Response`
Example:

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

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

Updates a connection under a data asset.

Parameters:	workspace_id (str) – (required) The workspace ID. connection_key (str) – (required) The connection key. update_connection_details (oci.data_integration.models.UpdateConnectionDetails) – (required) The information needed to update a connection. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

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

update_copy_object_request(workspace_id, copy_object_request_key, update_copy_object_request_details, **kwargs)¶

Updates the status of a copy object request.

Parameters:	workspace_id (str) – (required) The workspace ID. copy_object_request_key (str) – (required) The key of the object to be copied, for example this could be the key of a project. update_copy_object_request_details (oci.data_integration.models.UpdateCopyObjectRequestDetails) – (required) The details needed to update the status of a copy object 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CopyObjectRequest`
Return type:	`Response`
Example:

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

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) The workspace ID. data_asset_key (str) – (required) The data asset key. update_data_asset_details (oci.data_integration.models.UpdateDataAssetDetails) – (required) The information needed to update a data asset. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataAsset`
Return type:	`Response`
Example:

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

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

Updates a specific data flow.

Parameters:	workspace_id (str) – (required) The workspace ID. data_flow_key (str) – (required) The data flow key. update_data_flow_details (oci.data_integration.models.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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DataFlow`
Return type:	`Response`
Example:

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

update_dis_application(workspace_id, dis_application_id, update_dis_application_details, **kwargs)¶

Updates a DIS Application.

Parameters:	workspace_id (str) – (required) The workspace ID. dis_application_id (str) – (required) The OCID of the DIS Application. update_dis_application_details (oci.data_integration.models.UpdateDisApplicationDetails) – (required) The details needed to update an application. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DisApplication`
Return type:	`Response`
Example:

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

update_dis_application_detailed_description(workspace_id, application_key, update_dis_application_detailed_description_details, **kwargs)¶

Updates the detailed description of an Application.

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. update_dis_application_detailed_description_details (oci.data_integration.models.UpdateDetailedDescriptionDetails) – (required) The details needed to update the detailed description of 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DetailedDescription`
Return type:	`Response`
Example:

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

update_export_request(workspace_id, export_request_key, update_export_request_details, **kwargs)¶

Updates the status of a export object request.

Parameters:	workspace_id (str) – (required) The workspace ID. export_request_key (str) – (required) The key of the object export object request update_export_request_details (oci.data_integration.models.UpdateExportRequestDetails) – (required) The details needed to update the status of a export object 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExportRequest`
Return type:	`Response`
Example:

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

update_external_publication(workspace_id, task_key, external_publications_key, update_external_publication_details, **kwargs)¶

Updates the external publication object.

Parameters:	workspace_id (str) – (required) The workspace ID. task_key (str) – (required) The task key. external_publications_key (str) – (required) The external published object key. update_external_publication_details (oci.data_integration.models.UpdateExternalPublicationDetails) – (required) The information to be updated. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ExternalPublication`
Return type:	`Response`
Example:

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

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

Updates a specific folder.

Parameters:	workspace_id (str) – (required) The workspace ID. folder_key (str) – (required) The folder key. update_folder_details (oci.data_integration.models.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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Folder`
Return type:	`Response`
Example:

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

update_function_library(workspace_id, function_library_key, update_function_library_details, **kwargs)¶

Updates a specific Function Library.

Parameters:	workspace_id (str) – (required) The workspace ID. function_library_key (str) – (required) The functionLibrary key. update_function_library_details (oci.data_integration.models.UpdateFunctionLibraryDetails) – (required) The details needed to update a FunctionL ibrary. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `FunctionLibrary`
Return type:	`Response`
Example:

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

update_import_request(workspace_id, import_request_key, update_import_request_details, **kwargs)¶

Updates the status of a import object request.

Parameters:	workspace_id (str) – (required) The workspace ID. import_request_key (str) – (required) The key of the object export object request update_import_request_details (oci.data_integration.models.UpdateImportRequestDetails) – (required) The details needed to update the status of a import object 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. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ImportRequest`
Return type:	`Response`
Example:

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

update_pipeline(workspace_id, pipeline_key, update_pipeline_details, **kwargs)¶

Updates a specific pipeline.

Parameters:	workspace_id (str) – (required) The workspace ID. pipeline_key (str) – (required) The pipeline key. update_pipeline_details (oci.data_integration.models.UpdatePipelineDetails) – (required) The details needed to updated a pipeline. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Pipeline`
Return type:	`Response`
Example:

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

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

Updates a specific project.

Parameters:	workspace_id (str) – (required) The workspace ID. project_key (str) – (required) The project key. update_project_details (oci.data_integration.models.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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Project`
Return type:	`Response`
Example:

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

update_reference(workspace_id, application_key, reference_key, update_reference_details, **kwargs)¶

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

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. reference_key (str) – (required) The reference key. update_reference_details (oci.data_integration.models.UpdateReferenceDetails) – (required) The details needed to update the references. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Reference`
Return type:	`Response`
Example:

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

update_schedule(workspace_id, application_key, schedule_key, update_schedule_details, **kwargs)¶

Endpoint used to update the schedule

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. schedule_key (str) – (required) Schedule Key update_schedule_details (oci.data_integration.models.UpdateScheduleDetails) – (required) Request body parameter for Schedule details if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Schedule`
Return type:	`Response`
Example:

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

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) The workspace ID. task_key (str) – (required) The task key. update_task_details (oci.data_integration.models.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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Task`
Return type:	`Response`
Example:

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

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) The workspace ID. application_key (str) – (required) The application key. task_run_key (str) – (required) The task run key. update_task_run_details (oci.data_integration.models.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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskRunDetails`
Return type:	`Response`
Example:

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

update_task_schedule(workspace_id, application_key, task_schedule_key, update_task_schedule_details, **kwargs)¶

Endpoint used to update the TaskSchedule

Parameters:	workspace_id (str) – (required) The workspace ID. application_key (str) – (required) The application key. task_schedule_key (str) – (required) TaskSchedule Key update_task_schedule_details (oci.data_integration.models.UpdateTaskScheduleDetails) – (required) Request body parameter for TaskSchedule details if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TaskSchedule`
Return type:	`Response`
Example:

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

update_user_defined_function(workspace_id, user_defined_function_key, update_user_defined_function_details, **kwargs)¶

Updates a specific UserDefinedFunction.

Parameters:	workspace_id (str) – (required) The workspace ID. user_defined_function_key (str) – (required) The user defined function key. update_user_defined_function_details (oci.data_integration.models.UpdateUserDefinedFunctionDetails) – (required) The details needed to updated a UserDefinedFunction. 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) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `UserDefinedFunction`
Return type:	`Response`
Example:

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

update_workspace(workspace_id, update_workspace_details, **kwargs)¶

Updates the specified Data Integration workspace.

Parameters:	workspace_id (str) – (required) The workspace ID. update_workspace_details (oci.data_integration.models.UpdateWorkspaceDetails) – (required) The information needed to update the workspace. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code. 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. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Workspace`
Return type:	`Response`
Example:

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