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
change_application_compartment(…) Moves an application 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.
create_application(…) Creates an application.
create_private_endpoint(…) Creates a private endpoint to be used by applications.
create_run(create_run_details, **kwargs) Creates a run for an application.
delete_application(application_id, **kwargs) Deletes an application using an applicationId.
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.
get_application(application_id, **kwargs) Retrieves an application using an applicationId.
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_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_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_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.
update_application(…) Updates an application using an applicationId.
update_private_endpoint(…) Updates a private endpoint using a privateEndpointId.
update_run(update_run_details, run_id, **kwargs) Updates a run using a runId.
__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.
  • allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.
change_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_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.

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_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.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/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.

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

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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type Application
Return type:

Response
Example:

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

get_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 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 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 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 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 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 stream
Return type:

Response
Example:

Click here to see an example of how to use get_run_log 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type WorkRequest
Return type:

Response
Example:

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

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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of ApplicationSummary
Return type:

Response
Example:

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

list_private_endpoints(compartment_id, **kwargs)

Lists all private endpoints in the specified compartment.

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 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 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of 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.
  • 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 will not retry by default, users can also use the convenient DEFAULT_RETRY_STRATEGY provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here.

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

  • allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:

A Response object with data of type list of RunSummary
Return type:

Response
Example:

Click here to see an example of how to use list_runs 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 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 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 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 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 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 WorkRequestCollection
Return type:

Response
Example:

Click here to see an example of how to use list_work_requests 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_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.