oracle.oci.oci_data_connectivity_data_entity_facts – Fetches details about one or multiple DataEntity resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.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_connectivity_data_entity_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DataEntity resources in Oracle Cloud Infrastructure
Lists a summary of data entities from the data asset using the specified connection.
If data_entity_key is specified, the details of a single DataEntity will be returned.
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_mode
string
|
|
This parameter can be used to set the api response type to preview.
|
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
|
|
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
|
|
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.
|
|
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 . |
|
connection_key
string
/ required
|
The connection key.
|
|
data_entity_key
string
|
The key of the data entity.
Required to get a specific data_entity.
|
|
endpoint_id
string
|
Endpoint ID used for getDataAssetFullDetails.
|
|
fields
list
/ elements=string
|
Specifies the fields to get for an object.
|
|
include_types
list
/ elements=string
|
Artifact type which needs to be listed while listing Artifacts.
|
|
is_pattern
boolean
|
|
This parameter can be used to specify whether entity search type is a pattern search.
|
name
string
|
Used to filter by the name of the object.
|
|
name_list
list
/ elements=string
|
Used to filter by the name of the object.
|
|
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. |
|
registry_id
string
/ required
|
The registry OCID.
|
|
schema_resource_name
string
/ required
|
The schema resource name used for retrieving schemas.
|
|
sort_by
string
|
|
Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order are by relevance score in descending order).
|
sort_order
string
|
|
Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
|
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 |
|
type
string
|
Type of the object to filter the results with.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific data_entity
oci_data_connectivity_data_entity_facts:
# required
data_entity_key: data_entity_key_example
registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"
connection_key: connection_key_example
schema_resource_name: schema_resource_name_example
# optional
endpoint_id: "ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx"
- name: List data_entities
oci_data_connectivity_data_entity_facts:
# required
registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"
connection_key: connection_key_example
schema_resource_name: schema_resource_name_example
# optional
name: name_example
type: type_example
fields: [ "fields_example" ]
sort_by: id
sort_order: ASC
api_mode: PREVIEW
name_list: [ "name_list_example" ]
is_pattern: true
endpoint_id: "ocid1.endpoint.oc1..xxxxxxEXAMPLExxxxxx"
include_types: [ "include_types_example" ]
Authors¶
Oracle (@oracle)
There were some errors parsing the documentation for this plugin. Please file a bug with the collection.
The errors were:
Unable to normalize oci_data_connectivity_data_entity_facts: return due to: 8 validation errors for PluginReturnSchema return -> data_entities -> contains -> shape -> contains -> type -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> parent_ref -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> elements -> contains -> fields -> contains -> config_values -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> elements -> contains -> fields -> contains -> parent_ref -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> parent_type -> contains -> config_definition -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> parent_type -> contains -> parent_ref -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> parent_type -> contains -> parent_type -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> schema -> contains -> parent_ref -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$) return -> data_entities -> contains -> shape -> contains -> type -> contains -> wrapped_type -> contains -> parent_ref -> type string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)