oracle.oci.oci_data_flow_statement – Manage a Statement resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_data_flow_statement.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create and delete a Statement resource in Oracle Cloud Infrastructure
For state=present, executes a statement for a Session run.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user string		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_purpose string	Choices: service_principal	The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type string	Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle string		The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
code string		The statement code to execute. Example: `println(sc.version)` Required for create using state=present.
config_file_location string		Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string		The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
force_create boolean	Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by list / elements=string		The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
realm_specific_endpoint_template_enabled boolean	Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
region string		The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
run_id string / required		The unique ID for the run
state string	Choices: present ← absent	The state of the Statement. Use state=present to create a Statement. Use state=absent to delete a Statement.
statement_id string		The unique ID for the statement. Required for delete using state=absent. aliases: id
tenancy string		OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer		Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create statement
  oci_data_flow_statement:
    # required
    code: code_example
    run_id: "ocid1.run.oc1..xxxxxxEXAMPLExxxxxx"

- name: Delete statement
  oci_data_flow_statement:
    # required
    run_id: "ocid1.run.oc1..xxxxxxEXAMPLExxxxxx"
    statement_id: "ocid1.statement.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key				Returned	Description
statement complex				on success	Details of the Statement resource acted upon by the current operation Sample: {'code': 'code_example', 'id': 56, 'lifecycle_state': 'ACCEPTED', 'output': {'data': {'type': 'TEXT_PLAIN', 'value': None}, 'error_name': 'error_name_example', 'error_value': 'error_value_example', 'status': 'OK', 'traceback': []}, 'progress': 1.2, 'run_id': 'ocid1.run.oc1..xxxxxxEXAMPLExxxxxx', 'time_completed': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00'}
	code string			on success	The statement code to execute. Example: `println(sc.version)` Sample: code_example
	id integer			on success	The statement ID. Sample: 56
	lifecycle_state string			on success	The current state of this statement. Sample: ACCEPTED
	output complex			on success
		data complex		on success
			type string	on success	The type of the `StatementOutputData` like `TEXT_PLAIN`, `TEXT_HTML` or `IMAGE_PNG`. Sample: TEXT_PLAIN
			value string	on success	The statement code execution output in png format. Sample: null
		error_name string		on success	The name of the error in the statement output. Sample: error_name_example
		error_value string		on success	The value of the error in the statement output. Sample: error_value_example
		status string		on success	Status of the statement output. Sample: OK
		traceback list / elements=string		on success	The traceback of the statement output.
	progress float			on success	The execution progress. Sample: 1.2
	run_id string			on success	The ID of a run. Sample: ocid1.run.oc1..xxxxxxEXAMPLExxxxxx
	time_completed string			on success	The date and time a statement execution was completed, expressed in RFC 3339 timestamp format. Example: `2022-05-31T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	time_created string			on success	The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: `2018-04-03T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00

Authors¶

Oracle (@oracle)

oracle.oci.oci_data_flow_statement – Manage a Statement resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶