Data Flow Functions

Package: DBMS_CLOUD_OCI_DF_DATA_FLOW

CHANGE_APPLICATION_COMPARTMENT Function

Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like runs, will not be automatically moved.

Syntax

FUNCTION change_application_compartment (
  application_id varchar2,
  change_application_compartment_details dbms_cloud_oci_dataflow_change_application_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_change_application_compartment_response_t;

Parameters

Parameter	Description
`application_id`	(required) The unique ID for an application.
`change_application_compartment_details`	(required) Details for changing an application's compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_POOL_COMPARTMENT Function

Moves a pool into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The pool must be in a terminal state (STOPPED, FAILED) in order for it to be moved to a different compartment

Syntax

FUNCTION change_pool_compartment (
  pool_id varchar2,
  change_pool_compartment_details dbms_cloud_oci_dataflow_change_pool_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_change_pool_compartment_response_t;

Parameters

Parameter	Description
`pool_id`	(required) The unique ID for a pool.
`change_pool_compartment_details`	(required) Details for changing a pool's compartment.
`if_match`	(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.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PRIVATE_ENDPOINT_COMPARTMENT Function

Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_private_endpoint_compartment (
  private_endpoint_id varchar2,
  change_private_endpoint_compartment_details dbms_cloud_oci_dataflow_change_private_endpoint_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_change_private_endpoint_compartment_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The unique ID for a private endpoint.
`change_private_endpoint_compartment_details`	(required) Details for changing a private endpoint's compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_RUN_COMPARTMENT Function

Moves a run into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in order for it to be moved to a different compartment

Syntax

FUNCTION change_run_compartment (
  run_id varchar2,
  change_run_compartment_details dbms_cloud_oci_dataflow_change_run_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_change_run_compartment_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`change_run_compartment_details`	(required) Details for changing a run's compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SQL_ENDPOINT_COMPARTMENT Function

Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint.

Syntax

FUNCTION change_sql_endpoint_compartment (
  sql_endpoint_id varchar2,
  change_sql_endpoint_compartment_details dbms_cloud_oci_dataflow_change_sql_endpoint_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_change_sql_endpoint_compartment_response_t;

Parameters

Parameter	Description
`sql_endpoint_id`	(required) The unique id of the SQL Endpoint.
`change_sql_endpoint_compartment_details`	(required) The details to change the compartment of the Sql Endpoint.
`if_match`	(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.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_APPLICATION Function

Creates an application.

Syntax

FUNCTION create_application (
  create_application_details dbms_cloud_oci_dataflow_create_application_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_create_application_response_t;

Parameters

Parameter	Description
`create_application_details`	(required) Details to create an application.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_POOL Function

Create a pool to be used by dataflow runs or applications.

Syntax

FUNCTION create_pool (
  create_pool_details dbms_cloud_oci_dataflow_create_pool_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_create_pool_response_t;

Parameters

Parameter	Description
`create_pool_details`	(required) The parameter required to create a pool.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PRIVATE_ENDPOINT Function

Creates a private endpoint to be used by applications.

Syntax

FUNCTION create_private_endpoint (
  create_private_endpoint_details dbms_cloud_oci_dataflow_create_private_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_create_private_endpoint_response_t;

Parameters

Parameter	Description
`create_private_endpoint_details`	(required) The parameters required to create a private endpoint.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_RUN Function

Creates a run for an application.

Syntax

FUNCTION create_run (
  create_run_details dbms_cloud_oci_dataflow_create_run_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_create_run_response_t;

Parameters

Parameter	Description
`create_run_details`	(required) Details for creating a run of an application.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SQL_ENDPOINT Function

Create a new Sql Endpoint.

Syntax

FUNCTION create_sql_endpoint (
  create_sql_endpoint_details dbms_cloud_oci_dataflow_create_sql_endpoint_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_create_sql_endpoint_response_t;

Parameters

Parameter	Description
`create_sql_endpoint_details`	(required) Details of the new Sql Endpoint.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_STATEMENT Function

Executes a statement for a Session run.

Syntax

FUNCTION create_statement (
  create_statement_details dbms_cloud_oci_dataflow_create_statement_details_t,
  run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_create_statement_response_t;

Parameters

Parameter	Description
`create_statement_details`	(required) Details for creating a statement.
`run_id`	(required) The unique ID for the run
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_APPLICATION Function

Deletes an application using an `applicationId`.

Syntax

FUNCTION delete_application (
  application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_delete_application_response_t;

Parameters

Parameter	Description
`application_id`	(required) The unique ID for an application.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_POOL Function

Deletes a pool using a `poolId`.

Syntax

FUNCTION delete_pool (
  pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_delete_pool_response_t;

Parameters

Parameter	Description
`pool_id`	(required) The unique ID for a pool.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PRIVATE_ENDPOINT Function

Deletes a private endpoint using a `privateEndpointId`.

Syntax

FUNCTION delete_private_endpoint (
  private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_delete_private_endpoint_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The unique ID for a private endpoint.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_RUN Function

Cancels the specified run if it has not already completed or was previously cancelled. If a run is in progress, the executing job will be killed.

Syntax

FUNCTION delete_run (
  run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_delete_run_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SQL_ENDPOINT Function

Delete a Sql Endpoint resource, identified by the SqlEndpoint id.

Syntax

FUNCTION delete_sql_endpoint (
  sql_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_delete_sql_endpoint_response_t;

Parameters

Parameter	Description
`sql_endpoint_id`	(required) The unique id of the SQL Endpoint.
`if_match`	(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.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_STATEMENT Function

Cancels the specified statement for a Session run.

Syntax

FUNCTION delete_statement (
  run_id varchar2,
  statement_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_delete_statement_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`statement_id`	(required) The unique ID for the statement.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_APPLICATION Function

Retrieves an application using an `applicationId`.

Syntax

FUNCTION get_application (
  application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_application_response_t;

Parameters

Parameter	Description
`application_id`	(required) The unique ID for an application.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_POOL Function

Retrieves a pool using a `poolId`.

Syntax

FUNCTION get_pool (
  pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_pool_response_t;

Parameters

Parameter	Description
`pool_id`	(required) The unique ID for a pool.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PRIVATE_ENDPOINT Function

Retrieves an private endpoint using a `privateEndpointId`.

Syntax

FUNCTION get_private_endpoint (
  private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_private_endpoint_response_t;

Parameters

Parameter	Description
`private_endpoint_id`	(required) The unique ID for a private endpoint.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RUN Function

Retrieves the run for the specified `runId`.

Syntax

FUNCTION get_run (
  run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_run_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_RUN_LOG Function

Retrieves the content of an run log.

Syntax

FUNCTION get_run_log (
  run_id varchar2,
  name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_run_log_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`name`	(required) The name of the log. Avoid entering confidential information.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SQL_ENDPOINT Function

Retrieves a SQL Endpoint using a sqlEndpointId.

Syntax

FUNCTION get_sql_endpoint (
  sql_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_sql_endpoint_response_t;

Parameters

Parameter	Description
`sql_endpoint_id`	(required) The unique id of the SQL Endpoint.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_STATEMENT Function

Retrieves the statement corresponding to the `statementId` for a Session run specified by `runId`.

Syntax

FUNCTION get_statement (
  run_id varchar2,
  statement_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_statement_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`statement_id`	(required) The unique ID for the statement.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

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

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The unique ID for a work request.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_APPLICATIONS Function

Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

Syntax

FUNCTION list_applications (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  owner_principal_id varchar2 DEFAULT NULL,
  display_name_starts_with varchar2 DEFAULT NULL,
  spark_version varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_applications_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`sort_by`	(optional) The field used to sort the results. Multiple fields are not supported. Allowed values are: 'timeCreated', 'displayName', 'language'
`sort_order`	(optional) The ordering of results in ascending or descending order. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) The query parameter for the Spark application name.
`owner_principal_id`	(optional) The OCID of the user who created the resource.
`display_name_starts_with`	(optional) The displayName prefix.
`spark_version`	(optional) The Spark version utilized to run the application.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_POOLS Function

Lists all pools in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.

Syntax

FUNCTION list_pools (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  owner_principal_id varchar2 DEFAULT NULL,
  display_name_starts_with varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_pools_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`lifecycle_state`	(optional) The LifecycleState of the pool. Allowed values are: 'ACCEPTED', 'SCHEDULED', 'CREATING', 'ACTIVE', 'STOPPING', 'STOPPED', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`sort_by`	(optional) The field used to sort the results. Multiple fields are not supported. Allowed values are: 'timeCreated'
`sort_order`	(optional) The ordering of results in ascending or descending order. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) The query parameter for the Spark application name.
`owner_principal_id`	(optional) The OCID of the user who created the resource.
`display_name_starts_with`	(optional) The displayName prefix.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PRIVATE_ENDPOINTS Function

Lists all private endpoints in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.

Syntax

FUNCTION list_private_endpoints (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  owner_principal_id varchar2 DEFAULT NULL,
  display_name_starts_with varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_private_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`lifecycle_state`	(optional) The LifecycleState of the private endpoint. Allowed values are: 'CREATING', 'ACTIVE', 'INACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED'
`sort_by`	(optional) The field used to sort the results. Multiple fields are not supported. Allowed values are: 'timeCreated'
`sort_order`	(optional) The ordering of results in ascending or descending order. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) The query parameter for the Spark application name.
`owner_principal_id`	(optional) The OCID of the user who created the resource.
`display_name_starts_with`	(optional) The displayName prefix.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RUN_LOGS Function

Retrieves summaries of the run's logs.

Syntax

FUNCTION list_run_logs (
  run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_run_logs_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`limit`	(optional) The maximum number of results to return in a paginated \"List\" call.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_RUNS Function

Lists all runs of an application in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

Syntax

FUNCTION list_runs (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  application_id varchar2 DEFAULT NULL,
  pool_id varchar2 DEFAULT NULL,
  owner_principal_id varchar2 DEFAULT NULL,
  display_name_starts_with varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  time_created_greater_than timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_runs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`application_id`	(optional) The ID of the application.
`pool_id`	(optional) The ID of the pool.
`owner_principal_id`	(optional) The OCID of the user who created the resource.
`display_name_starts_with`	(optional) The displayName prefix.
`lifecycle_state`	(optional) The LifecycleState of the run. Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'CANCELING', 'CANCELED', 'FAILED', 'SUCCEEDED', 'STOPPING', 'STOPPED'
`time_created_greater_than`	(optional) The epoch time that the resource was created.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`sort_by`	(optional) The field used to sort the results. Multiple fields are not supported. Allowed values are: 'timeCreated', 'displayName', 'language', 'runDurationInMilliseconds', 'lifecycleState', 'totalOCpu', 'dataReadInBytes', 'dataWrittenInBytes'
`sort_order`	(optional) The ordering of results in ascending or descending order. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) The query parameter for the Spark application name.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SQL_ENDPOINTS Function

Lists all Sql Endpoints in the specified compartment. The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.

Syntax

FUNCTION list_sql_endpoints (
  compartment_id varchar2 DEFAULT NULL,
  sql_endpoint_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_sql_endpoints_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment in which to query resources.
`sql_endpoint_id`	(optional) The unique id of the SQL Endpoint.
`lifecycle_state`	(optional) A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`display_name`	(optional) The query parameter for the Spark application name.
`limit`	(optional) The maximum number of items that can be returned.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The ordering of results in ascending or descending order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified timeCreated is used by default. Allowed values are: 'id', 'timeCreated', 'displayName'
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_STATEMENTS Function

Lists all statements for a Session run.

Syntax

FUNCTION list_statements (
  run_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_statements_response_t;

Parameters

Parameter	Description
`run_id`	(required) The unique ID for the run
`lifecycle_state`	(optional) The LifecycleState of the statement. Allowed values are: 'ACCEPTED', 'CANCELLING', 'CANCELLED', 'FAILED', 'IN_PROGRESS', 'SUCCEEDED'
`sort_by`	(optional) The field used to sort the results. Multiple fields are not supported. Allowed values are: 'timeCreated'
`sort_order`	(optional) The ordering of results in ascending or descending order. Allowed values are: 'ASC', 'DESC'
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

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

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The unique ID for a work request.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

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

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The unique ID for a work request.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(optional) The maximum number of results to return in a paginated `List` call.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`page`	(optional) The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_POOL Function

Starts the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION start_pool (
  pool_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_start_pool_response_t;

Parameters

Parameter	Description
`pool_id`	(required) The unique ID for a pool.
`if_match`	(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.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_POOL Function

Stops the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION stop_pool (
  pool_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_stop_pool_response_t;

Parameters

Parameter	Description
`pool_id`	(required) The unique ID for a pool.
`if_match`	(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.
`opc_retry_token`	(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 tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_APPLICATION Function

Updates an application using an `applicationId`.

Syntax

FUNCTION update_application (
  update_application_details dbms_cloud_oci_dataflow_update_application_details_t,
  application_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_update_application_response_t;

Parameters

Parameter	Description
`update_application_details`	(required) Details for updating an application.
`application_id`	(required) The unique ID for an application.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_POOL Function

Updates a pool using a `poolId`.If changes to a pool doesn't match a previously defined pool,then a 409 status code will be returned.This indicates that a conflict has been detected.

Syntax

FUNCTION update_pool (
  update_pool_details dbms_cloud_oci_dataflow_update_pool_details_t,
  pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_update_pool_response_t;

Parameters

Parameter	Description
`update_pool_details`	(required) Details for updating a pool.
`pool_id`	(required) The unique ID for a pool.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PRIVATE_ENDPOINT Function

Updates a private endpoint using a `privateEndpointId`. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code will be returned. This indicates that a conflict has been detected.

Syntax

FUNCTION update_private_endpoint (
  update_private_endpoint_details dbms_cloud_oci_dataflow_update_private_endpoint_details_t,
  private_endpoint_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_update_private_endpoint_response_t;

Parameters

Parameter	Description
`update_private_endpoint_details`	(required) Details for updating a private endpoint.
`private_endpoint_id`	(required) The unique ID for a private endpoint.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_RUN Function

Updates a run using a `runId`.

Syntax

FUNCTION update_run (
  update_run_details dbms_cloud_oci_dataflow_update_run_details_t,
  run_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_update_run_response_t;

Parameters

Parameter	Description
`update_run_details`	(required) Details for updating a run.
`run_id`	(required) The unique ID for the run
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SQL_ENDPOINT Function

Update a Sql Endpoint resource, identified by the SqlEndpoint id.

Syntax

FUNCTION update_sql_endpoint (
  update_sql_endpoint_details dbms_cloud_oci_dataflow_update_sql_endpoint_details_t,
  sql_endpoint_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_df_data_flow_update_sql_endpoint_response_t;

Parameters

Parameter	Description
`update_sql_endpoint_details`	(required) Details of the Sql Endpoint to be updated.
`sql_endpoint_id`	(required) The unique id of the SQL Endpoint.
`if_match`	(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.
`opc_request_id`	(optional) Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dataflow.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

CHANGE_APPLICATION_COMPARTMENT Function 🔗

CHANGE_POOL_COMPARTMENT Function 🔗

CHANGE_PRIVATE_ENDPOINT_COMPARTMENT Function 🔗

CHANGE_RUN_COMPARTMENT Function 🔗

CHANGE_SQL_ENDPOINT_COMPARTMENT Function 🔗

CREATE_APPLICATION Function 🔗

CREATE_POOL Function 🔗

CREATE_PRIVATE_ENDPOINT Function 🔗

CREATE_RUN Function 🔗

CREATE_SQL_ENDPOINT Function 🔗

CREATE_STATEMENT Function 🔗

DELETE_APPLICATION Function 🔗

DELETE_POOL Function 🔗

DELETE_PRIVATE_ENDPOINT Function 🔗

DELETE_RUN Function 🔗

DELETE_SQL_ENDPOINT Function 🔗

DELETE_STATEMENT Function 🔗

GET_APPLICATION Function 🔗

GET_POOL Function 🔗

GET_PRIVATE_ENDPOINT Function 🔗

GET_RUN Function 🔗

GET_RUN_LOG Function 🔗

GET_SQL_ENDPOINT Function 🔗

GET_STATEMENT Function 🔗

GET_WORK_REQUEST Function 🔗

LIST_APPLICATIONS Function 🔗

LIST_POOLS Function 🔗

LIST_PRIVATE_ENDPOINTS Function 🔗

LIST_RUN_LOGS Function 🔗

LIST_RUNS Function 🔗

LIST_SQL_ENDPOINTS Function 🔗

LIST_STATEMENTS Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

START_POOL Function 🔗

STOP_POOL Function 🔗

UPDATE_APPLICATION Function 🔗

UPDATE_POOL Function 🔗

UPDATE_PRIVATE_ENDPOINT Function 🔗

UPDATE_RUN Function 🔗

UPDATE_SQL_ENDPOINT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CHANGE_APPLICATION_COMPARTMENT Function

CHANGE_POOL_COMPARTMENT Function

CHANGE_PRIVATE_ENDPOINT_COMPARTMENT Function

CHANGE_RUN_COMPARTMENT Function

CHANGE_SQL_ENDPOINT_COMPARTMENT Function

CREATE_APPLICATION Function

CREATE_POOL Function

CREATE_PRIVATE_ENDPOINT Function

CREATE_RUN Function

CREATE_SQL_ENDPOINT Function

CREATE_STATEMENT Function

DELETE_APPLICATION Function

DELETE_POOL Function

DELETE_PRIVATE_ENDPOINT Function

DELETE_RUN Function

DELETE_SQL_ENDPOINT Function

DELETE_STATEMENT Function

GET_APPLICATION Function

GET_POOL Function

GET_PRIVATE_ENDPOINT Function

GET_RUN Function

GET_RUN_LOG Function

GET_SQL_ENDPOINT Function

GET_STATEMENT Function

GET_WORK_REQUEST Function

LIST_APPLICATIONS Function

LIST_POOLS Function

LIST_PRIVATE_ENDPOINTS Function

LIST_RUN_LOGS Function

LIST_RUNS Function

LIST_SQL_ENDPOINTS Function

LIST_STATEMENTS Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

START_POOL Function

STOP_POOL Function

UPDATE_APPLICATION Function

UPDATE_POOL Function

UPDATE_PRIVATE_ENDPOINT Function

UPDATE_RUN Function

UPDATE_SQL_ENDPOINT Function