DataFlowClient

class oci.data_flow.DataFlowClient(config, **kwargs)

Use the Data Flow APIs to run any Apache Spark application at any scale without deploying or managing any infrastructure.

Methods

__init__(config, **kwargs)	Creates a new service client
cascading_delete_application(application_id, …)	Deletes an application using an applicationId and terminates related runs.
change_application_compartment(…)	Moves an application into a different compartment.
change_pool_compartment(pool_id, …)	Moves a pool into a different compartment.
change_private_endpoint_compartment(…)	Moves a private endpoint into a different compartment.
change_run_compartment(run_id, …)	Moves a run into a different compartment.
change_sql_endpoint_compartment(…)	Moves an Sql Endpoint from one compartment to another.
create_application(…)	Creates an application.
create_pool(create_pool_details, **kwargs)	Create a pool to be used by dataflow runs or applications.
create_private_endpoint(…)	Creates a private endpoint to be used by applications.
create_run(create_run_details, **kwargs)	Creates a run for an application.
create_sql_endpoint(…)	Create a new Sql Endpoint.
create_statement(create_statement_details, …)	Executes a statement for a Session run.
delete_application(application_id, **kwargs)	Deletes an application using an applicationId.
delete_pool(pool_id, **kwargs)	Deletes a pool using a poolId.
delete_private_endpoint(private_endpoint_id, …)	Deletes a private endpoint using a privateEndpointId.
delete_run(run_id, **kwargs)	Cancels the specified run if it has not already completed or was previously cancelled.
delete_sql_endpoint(sql_endpoint_id, **kwargs)	Delete a Sql Endpoint resource, identified by the SqlEndpoint id.
delete_statement(run_id, statement_id, **kwargs)	Cancels the specified statement for a Session run.
get_application(application_id, **kwargs)	Retrieves an application using an applicationId.
get_pool(pool_id, **kwargs)	Retrieves a pool using a poolId.
get_private_endpoint(private_endpoint_id, …)	Retrieves an private endpoint using a privateEndpointId.
get_run(run_id, **kwargs)	Retrieves the run for the specified runId.
get_run_log(run_id, name, **kwargs)	Retrieves the content of an run log.
get_sql_endpoint(sql_endpoint_id, **kwargs)	Retrieves a SQL Endpoint using a sqlEndpointId.
get_statement(run_id, statement_id, **kwargs)	Retrieves the statement corresponding to the statementId for a Session run specified by runId.
get_work_request(work_request_id, **kwargs)	Gets the status of the work request with the given OCID.
list_applications(compartment_id, **kwargs)	Lists all applications in the specified compartment.
list_pools(compartment_id, **kwargs)	Lists all pools in the specified compartment.
list_private_endpoints(compartment_id, **kwargs)	Lists all private endpoints in the specified compartment.
list_run_logs(run_id, **kwargs)	Retrieves summaries of the run’s logs.
list_runs(compartment_id, **kwargs)	Lists all runs of an application in the specified compartment.
list_sql_endpoints(**kwargs)	Lists all Sql Endpoints in the specified compartment.
list_statements(run_id, **kwargs)	Lists all statements for a Session run.
list_work_request_errors(work_request_id, …)	Return a (paginated) list of errors for a given work request.
list_work_request_logs(work_request_id, **kwargs)	Return a paginated list of logs for a given work request.
list_work_requests(compartment_id, **kwargs)	Lists the work requests in a compartment.
start_pool(pool_id, **kwargs)	Starts the dataflow pool for a given poolId.
start_sql_endpoint(sql_endpoint_id, **kwargs)	Starts the SqlEndpoint for a given SqlEndpointId.
stop_pool(pool_id, **kwargs)	Stops the dataflow pool for a given poolId.
stop_sql_endpoint(sql_endpoint_id, **kwargs)	Stops the SqlEndpoint for a given SqlEndpointId.
update_application(…)	Updates an application using an applicationId.
update_pool(update_pool_details, pool_id, …)	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.
update_private_endpoint(…)	Updates a private endpoint using a privateEndpointId.
update_run(update_run_details, run_id, **kwargs)	Updates a run using a runId.
update_sql_endpoint(…)	Update a Sql Endpoint resource, identified by the SqlEndpoint id.

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

cascading_delete_application(application_id, **kwargs)

Deletes an application using an applicationId and terminates related runs. This operation will timeout in approximate 30 minutes if any related Runs are not terminated successfully.

Parameters:

• application_id (str) – (required) The unique ID for an application.
• opc_request_id (str) – (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 (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.
• 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 cascading_delete_application API.

change_application_compartment(application_id, change_application_compartment_details, **kwargs)

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.

Parameters:

• application_id (str) – (required) The unique ID for an application.
• change_application_compartment_details (oci.data_flow.models.ChangeApplicationCompartmentDetails) – (required) Details for changing an application’s compartment.
• opc_request_id (str) – (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 (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.
• 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 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.
• 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_application_compartment API.

change_pool_compartment(pool_id, change_pool_compartment_details, **kwargs)

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

Parameters:

• pool_id (str) – (required) The unique ID for a pool.
• change_pool_compartment_details (oci.data_flow.models.ChangePoolCompartmentDetails) – (required) Details for changing a pool’s 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.
• 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 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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_pool_compartment API.

change_private_endpoint_compartment(private_endpoint_id, change_private_endpoint_compartment_details, **kwargs)

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

Parameters:

• private_endpoint_id (str) – (required) The unique ID for a private endpoint.
• change_private_endpoint_compartment_details (oci.data_flow.models.ChangePrivateEndpointCompartmentDetails) – (required) Details for changing a private endpoint’s compartment.
• opc_request_id (str) – (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 (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.
• 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_private_endpoint_compartment API.

change_run_compartment(run_id, change_run_compartment_details, **kwargs)

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

Parameters:

• run_id (str) – (required) The unique ID for the run
• change_run_compartment_details (oci.data_flow.models.ChangeRunCompartmentDetails) – (required) Details for changing a run’s compartment.
• opc_request_id (str) – (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 (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.
• 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 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.
• 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_run_compartment API.

change_sql_endpoint_compartment(sql_endpoint_id, change_sql_endpoint_compartment_details, **kwargs)

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

Parameters:

• sql_endpoint_id (str) – (required) The unique id of the SQL Endpoint.
• change_sql_endpoint_compartment_details (oci.data_flow.models.ChangeSqlEndpointCompartmentDetails) – (required) The details to change the compartment of the Sql Endpoint.
• 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.
• opc_request_id (str) – (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 (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 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.
• 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_sql_endpoint_compartment API.

create_application(create_application_details, **kwargs)

Creates an application.

Parameters:

• create_application_details (oci.data_flow.models.CreateApplicationDetails) – (required) Details to create an application.
• 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 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 (str) – (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.
• 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_pool(create_pool_details, **kwargs)

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

Parameters:

• create_pool_details (oci.data_flow.models.CreatePoolDetails) – (required) The parameter required to create a pool.
• 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 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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 Pool

Return type:

Response

Example:

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

create_private_endpoint(create_private_endpoint_details, **kwargs)

Creates a private endpoint to be used by applications.

Parameters:

• create_private_endpoint_details (oci.data_flow.models.CreatePrivateEndpointDetails) – (required) The parameters required to create a private endpoint.
• 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 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 (str) – (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.
• 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 PrivateEndpoint

Return type:

Response

Example:

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

create_run(create_run_details, **kwargs)

Creates a run for an application.

Parameters:

• create_run_details (oci.data_flow.models.CreateRunDetails) – (required) Details for creating a run of an application.
• 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 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 (str) – (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_parent_rpt_url (str) – (optional) (Optional header param, required for Resource Principal version 3.0+) Parent resource control plane endpoint used to exchange for upper level resource principal token.
• 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 Run

Return type:

Response

Example:

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

create_sql_endpoint(create_sql_endpoint_details, **kwargs)

Create a new Sql Endpoint.

Parameters:

• create_sql_endpoint_details (oci.data_flow.models.CreateSqlEndpointDetails) – (required) Details of the new Sql Endpoint.
• 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 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 (str) – (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.
• 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 SqlEndpoint

Return type:

Response

Example:

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

create_statement(create_statement_details, run_id, **kwargs)

Executes a statement for a Session run.

Parameters:

• create_statement_details (oci.data_flow.models.CreateStatementDetails) – (required) Details for creating a statement.
• run_id (str) – (required) The unique ID for the run
• opc_request_id (str) – (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.
• 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 Statement

Return type:

Response

Example:

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

delete_application(application_id, **kwargs)

Deletes an application using an applicationId.

Parameters:

• application_id (str) – (required) The unique ID for an application.
• opc_request_id (str) – (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 (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.
• 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_pool(pool_id, **kwargs)

Deletes a pool using a poolId.

Parameters:

• pool_id (str) – (required) The unique ID for a pool.
• opc_request_id (str) – (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 (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.
• 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_pool API.

delete_private_endpoint(private_endpoint_id, **kwargs)

Deletes a private endpoint using a privateEndpointId.

Parameters:

• private_endpoint_id (str) – (required) The unique ID for a private endpoint.
• opc_request_id (str) – (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 (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.
• 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_private_endpoint API.

delete_run(run_id, **kwargs)

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.

Parameters:

• run_id (str) – (required) The unique ID for the run
• opc_request_id (str) – (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 (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.
• 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_run API.

delete_sql_endpoint(sql_endpoint_id, **kwargs)

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

Parameters:

• sql_endpoint_id (str) – (required) The unique id of the SQL Endpoint.
• 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.
• opc_request_id (str) – (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.
• 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_sql_endpoint API.

delete_statement(run_id, statement_id, **kwargs)

Cancels the specified statement for a Session run.

Parameters:

• run_id (str) – (required) The unique ID for the run
• statement_id (str) – (required) The unique ID for the statement.
• opc_request_id (str) – (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 (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_statement API.

get_application(application_id, **kwargs)

Retrieves an application using an applicationId.

Parameters:

• application_id (str) – (required) The unique ID for an application.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_pool(pool_id, **kwargs)

Retrieves a pool using a poolId.

Parameters:

• pool_id (str) – (required) The unique ID for a pool.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 Pool

Return type:

Response

Example:

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

get_private_endpoint(private_endpoint_id, **kwargs)

Retrieves an private endpoint using a privateEndpointId.

Parameters:

• private_endpoint_id (str) – (required) The unique ID for a private endpoint.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 PrivateEndpoint

Return type:

Response

Example:

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

get_run(run_id, **kwargs)

Retrieves the run for the specified runId.

Parameters:

• run_id (str) – (required) The unique ID for the run
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 Run

Return type:

Response

Example:

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

get_run_log(run_id, name, **kwargs)

Retrieves the content of an run log.

Parameters:

• run_id (str) – (required) The unique ID for the run
• name (str) – (required) The name of the log. Avoid entering confidential information.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 stream

Return type:

Response

Example:

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

get_sql_endpoint(sql_endpoint_id, **kwargs)

Retrieves a SQL Endpoint using a sqlEndpointId.

Parameters:

• sql_endpoint_id (str) – (required) The unique id of the SQL Endpoint.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 SqlEndpoint

Return type:

Response

Example:

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

get_statement(run_id, statement_id, **kwargs)

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

Parameters:

• run_id (str) – (required) The unique ID for the run
• statement_id (str) – (required) The unique ID for the statement.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 Statement

Return type:

Response

Example:

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

get_work_request(work_request_id, **kwargs)

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

Parameters:

• work_request_id (str) – (required) The unique ID for a work request.
• opc_request_id (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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.

list_applications(compartment_id, **kwargs)

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.

Parameters:

• compartment_id (str) – (required) The OCID of the compartment.
• opc_request_id (str) – (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 (int) – (optional) The maximum number of results to return in a paginated List call.
• page (str) – (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 (str) –

  (optional) The field used to sort the results. Multiple fields are not supported.

  Allowed values are: “timeCreated”, “displayName”, “language”

• sort_order (str) –

  (optional) The ordering of results in ascending or descending order.

  Allowed values are: “ASC”, “DESC”

• display_name (str) – (optional) The query parameter for the Spark application name.
• owner_principal_id (str) – (optional) The OCID of the user who created the resource.
• display_name_starts_with (str) – (optional) The displayName prefix.
• spark_version (str) – (optional) The Spark version utilized to run the application.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 ApplicationSummary

Return type:

Response

Example:

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

list_pools(compartment_id, **kwargs)

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.

Parameters:

• compartment_id (str) – (required) The OCID of the compartment.
• opc_request_id (str) – (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 (int) – (optional) The maximum number of results to return in a paginated List call.
• page (str) – (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 (str) –

  (optional) The LifecycleState of the pool.

  Allowed values are: “ACCEPTED”, “SCHEDULED”, “CREATING”, “ACTIVE”, “STOPPING”, “STOPPED”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• sort_by (str) –

  (optional) The field used to sort the results. Multiple fields are not supported.

  Allowed values are: “timeCreated”

• sort_order (str) –

  (optional) The ordering of results in ascending or descending order.

  Allowed values are: “ASC”, “DESC”

• display_name (str) – (optional) The query parameter for the Spark application name.
• owner_principal_id (str) – (optional) The OCID of the user who created the resource.
• display_name_starts_with (str) – (optional) The displayName prefix.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 PoolCollection

Return type:

Response

Example:

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

list_private_endpoints(compartment_id, **kwargs)

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.

Parameters:

• compartment_id (str) – (required) The OCID of the compartment.
• opc_request_id (str) – (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 (int) – (optional) The maximum number of results to return in a paginated List call.
• page (str) – (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 (str) –

  (optional) The LifecycleState of the private endpoint.

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

• sort_by (str) –

  (optional) The field used to sort the results. Multiple fields are not supported.

  Allowed values are: “timeCreated”

• sort_order (str) –

  (optional) The ordering of results in ascending or descending order.

  Allowed values are: “ASC”, “DESC”

• display_name (str) – (optional) The query parameter for the Spark application name.
• owner_principal_id (str) – (optional) The OCID of the user who created the resource.
• display_name_starts_with (str) – (optional) The displayName prefix.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 PrivateEndpointCollection

Return type:

Response

Example:

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

list_run_logs(run_id, **kwargs)

Retrieves summaries of the run’s logs.

Parameters:

• run_id (str) – (required) The unique ID for the run
• opc_request_id (str) – (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 (int) – (optional) The maximum number of results to return in a paginated “List” call.
• page (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 RunLogSummary

Return type:

Response

Example:

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

list_runs(compartment_id, **kwargs)

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.

Parameters:

• compartment_id (str) – (required) The OCID of the compartment.
• opc_request_id (str) – (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 (str) – (optional) The ID of the application.
• pool_id (str) – (optional) The ID of the pool.
• owner_principal_id (str) – (optional) The OCID of the user who created the resource.
• display_name_starts_with (str) – (optional) The displayName prefix.
• lifecycle_state (str) –

  (optional) The LifecycleState of the run.

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

• time_created_greater_than (datetime) – (optional) The epoch time that the resource was created.
• limit (int) – (optional) The maximum number of results to return in a paginated List call.
• page (str) – (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 (str) –

  (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 (str) –

  (optional) The ordering of results in ascending or descending order.

  Allowed values are: “ASC”, “DESC”

• display_name (str) – (optional) The query parameter for the Spark application name.
• retry_strategy (obj) –

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

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 RunSummary

Return type:

Response

Example:

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

list_sql_endpoints(**kwargs)

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.

Parameters:

• compartment_id (str) – (optional) The OCID of the compartment in which to query resources.
• sql_endpoint_id (str) – (optional) The unique id of the SQL Endpoint.
• lifecycle_state (str) –

  (optional) A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.

  Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, “NEEDS_ATTENTION”, “INACTIVE”

• display_name (str) – (optional) The query parameter for the Spark application name.
• limit (int) – (optional) The maximum number of items that can be returned.
• page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
• sort_order (str) –

  (optional) The ordering of results in ascending or descending order.

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

  (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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 SqlEndpointCollection

Return type:

Response

Example:

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

list_statements(run_id, **kwargs)

Lists all statements for a Session run.

Parameters:

• run_id (str) – (required) The unique ID for the run
• lifecycle_state (str) –

  (optional) The LifecycleState of the statement.

  Allowed values are: “ACCEPTED”, “CANCELLING”, “CANCELLED”, “FAILED”, “IN_PROGRESS”, “SUCCEEDED”

• sort_by (str) –

  (optional) The field used to sort the results. Multiple fields are not supported.

  Allowed values are: “timeCreated”

• sort_order (str) –

  (optional) The ordering of results in ascending or descending order.

  Allowed values are: “ASC”, “DESC”

• limit (int) – (optional) The maximum number of results to return in a paginated List call.
• page (str) – (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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 StatementCollection

Return type:

Response

Example:

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

list_work_request_errors(work_request_id, **kwargs)

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

Parameters:

• work_request_id (str) – (required) The unique ID for a work request.
• limit (int) – (optional) The maximum number of results to return in a paginated List call.
• opc_request_id (str) – (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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 WorkRequestErrorCollection

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)

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

Parameters:

• work_request_id (str) – (required) The unique ID for a work request.
• limit (int) – (optional) The maximum number of results to return in a paginated List call.
• opc_request_id (str) – (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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 WorkRequestLogCollection

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.
• limit (int) – (optional) The maximum number of results to return in a paginated List call.
• opc_request_id (str) – (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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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 WorkRequestCollection

Return type:

Response

Example:

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

start_pool(pool_id, **kwargs)

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

Parameters:

• pool_id (str) – (required) The unique ID for a pool.
• 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.
• 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 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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_pool API.

start_sql_endpoint(sql_endpoint_id, **kwargs)

Starts the SqlEndpoint for a given SqlEndpointId. When provided, If-Match is checked against ETag values of the resource.

Parameters:

• sql_endpoint_id (str) – (required) The unique id of the SQL Endpoint.
• 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.
• opc_request_id (str) – (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 (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 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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_sql_endpoint API.

stop_pool(pool_id, **kwargs)

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

Parameters:

• pool_id (str) – (required) The unique ID for a pool.
• 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.
• 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 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 (str) – (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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_pool API.

stop_sql_endpoint(sql_endpoint_id, **kwargs)

Stops the SqlEndpoint for a given SqlEndpointId. When provided, If-Match is checked against ETag values of the resource.

Parameters:

• sql_endpoint_id (str) – (required) The unique id of the SQL Endpoint.
• 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.
• opc_request_id (str) – (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 (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 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.
• 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 uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. 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_sql_endpoint API.

update_application(update_application_details, application_id, **kwargs)

Updates an application using an applicationId.

Parameters:

• update_application_details (oci.data_flow.models.UpdateApplicationDetails) – (required) Details for updating an application.
• application_id (str) – (required) The unique ID for an application.
• opc_request_id (str) – (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 (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.
• 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_pool(update_pool_details, pool_id, **kwargs)

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.

Parameters:

• update_pool_details (oci.data_flow.models.UpdatePoolDetails) – (required) Details for updating a pool.
• pool_id (str) – (required) The unique ID for a pool.
• opc_request_id (str) – (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 (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.
• 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 update_pool API.

update_private_endpoint(update_private_endpoint_details, private_endpoint_id, **kwargs)

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.

Parameters:

• update_private_endpoint_details (oci.data_flow.models.UpdatePrivateEndpointDetails) – (required) Details for updating a private endpoint.
• private_endpoint_id (str) – (required) The unique ID for a private endpoint.
• opc_request_id (str) – (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 (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.
• 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 update_private_endpoint API.

update_run(update_run_details, run_id, **kwargs)

Updates a run using a runId.

Parameters:

• update_run_details (oci.data_flow.models.UpdateRunDetails) – (required) Details for updating a run.
• run_id (str) – (required) The unique ID for the run
• opc_request_id (str) – (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 (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.
• 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 Run

Return type:

Response

Example:

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

update_sql_endpoint(update_sql_endpoint_details, sql_endpoint_id, **kwargs)

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

Parameters:

• update_sql_endpoint_details (oci.data_flow.models.UpdateSqlEndpointDetails) – (required) Details of the Sql Endpoint to be updated.
• sql_endpoint_id (str) – (required) The unique id of the SQL Endpoint.
• 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.
• opc_request_id (str) – (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.
• 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 update_sql_endpoint API.