oracle.oci.oci_data_catalog_data_asset_actions – Perform actions on a DataAsset resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.13.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_catalog_data_asset_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DataAsset resource in Oracle Cloud Infrastructure

  • For action=add_data_selector_patterns, add data selector pattern to the data asset.

  • For action=import_connection, import new connection for this data asset.

  • For action=import_data_asset, import technical objects to a Data Asset

  • For action=parse_connection, parse data asset references through connections from this data asset.

  • For action=remove_data_selector_patterns, remove data selector pattern from the data asset.

  • For action=synchronous_export, export technical objects from a Data Asset

  • For action=validate_connection, validate connection by connecting to the data asset using credentials in metadata.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • add_data_selector_patterns
  • import_connection
  • import_data_asset
  • parse_connection
  • remove_data_selector_patterns
  • synchronous_export
  • validate_connection
The action to perform on the DataAsset.
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
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.
catalog_id
string / required
Unique catalog identifier.
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_detail
dictionary
Applicable only for action=import_connectionaction=parse_connectionaction=validate_connection.
created_by_id
string
OCID of the user who created the connection.
custom_property_members
list / elements=dictionary
The list of customized properties along with the values for this object
allowed_values
list / elements=string
Allowed values for the custom property if any
data_type
string
    Choices:
  • TEXT
  • RICH_TEXT
  • BOOLEAN
  • NUMBER
  • DATE
The data type of the custom property
description
string
Description of the custom property
display_name
string
Name of the custom property

aliases: name
is_editable
boolean
    Choices:
  • no
  • yes
If this field is a editable field
is_event_enabled
boolean
    Choices:
  • no
  • yes
If an OCI Event will be emitted when the custom property is modified.
is_hidden
boolean
    Choices:
  • no
  • yes
If this field is a hidden field
is_list_type
boolean
    Choices:
  • no
  • yes
Is this property allowed to have list of values
is_multi_valued
boolean
    Choices:
  • no
  • yes
If this field allows multiple values to be set
is_shown_in_list
boolean
    Choices:
  • no
  • yes
If this field is displayed in a list view of applicable objects.
key
string
Unique Identifier of the attribute which is ID
namespace_key
string
Unique namespace key that is immutable
namespace_name
string
Namespace name of the custom property
value
string
The custom property value
data_asset_key
string
Unique key of the parent data asset.
description
string
A description of the connection.
display_name
string
A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
enc_properties
dictionary
A map of maps that contains the encrypted values for sensitive properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: `{"encProperties": { "default": { "password": "example-password"}}}`
external_key
string
Unique external key of this object from the source system.
is_default
boolean
    Choices:
  • no
  • yes
Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
key
string
Unique connection key that is immutable.
lifecycle_state
string
    Choices:
  • CREATING
  • ACTIVE
  • INACTIVE
  • UPDATING
  • DELETING
  • DELETED
  • FAILED
  • MOVING
The current state of the connection.
properties
dictionary
A map of maps that contains the properties which are specific to the connection type. Each connection type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most connections have required properties within the "default" category. To determine the set of optional and required properties for a connection type, a query can be done on '/types?type=connection' that returns a collection of all connection types. The appropriate connection type, which will include definitions of all of it's properties, can be identified from this collection. Example: `{"properties": { "default": { "username": "user1"}}}`
time_created
string
The date and time the connection was created, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`
time_status_updated
string
Time that the connections status was last updated. An RFC3339 formatted datetime string.
time_updated
string
The last time that any change was made to the connection. An RFC3339 formatted datetime string.
type_key
string
The key of the object type. Type key's can be found via the '/types' endpoint.
updated_by_id
string
OCID of the user who modified the connection.
uri
string
URI to the connection instance in the API.
connection_key
string
Unique connection key.
Applicable only for action=parse_connection.
connection_payload
string
The information used to import the connection.
Required for action=import_connection.
data_asset_key
string / required
Unique data asset key.
dest
string
The destination file path to write the output. The file will be created if it does not exist. If the file already exists, the content will be overwritten.
Required for action=synchronous_export.
export_scope
list / elements=dictionary
Array of objects and their child types to be selected for export.
Applicable only for action=synchronous_export.
export_type_ids
list / elements=string
Array of type keys selected for export.
object_key
string
Unique key of the object selected for export.
export_type
list / elements=string
    Choices:
  • CUSTOM_PROPERTY_VALUES
  • ALL
Type of export.
Required for action=synchronous_export.
import_file_contents
string
The file contents to be imported. File size not to exceed 10 MB.
Required for action=import_data_asset.
import_type
list / elements=string
    Choices:
  • CUSTOM_PROPERTY_VALUES
  • ALL
Type of import.
Required for action=import_data_asset.
is_missing_value_ignored
boolean
    Choices:
  • no
  • yes
Specify whether to ignore the missing values in the import file.
Applicable only for action=import_data_asset.
items
list / elements=string
Collection of pattern Ids.
Required for action=add_data_selector_patterns, action=remove_data_selector_patterns.
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.
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.
wallet_secret_id
string
OCID of the OCI Vault secret holding the Oracle wallet to parse.
Applicable only for action=parse_connection.
wallet_secret_name
string
Name of the OCI Vault secret holding the Oracle wallet to parse.
Applicable only for action=parse_connection.

Examples

- name: Perform action add_data_selector_patterns on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    items: [ "items_example" ]
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    action: add_data_selector_patterns

- name: Perform action import_connection on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    connection_payload: connection_payload_example
    action: import_connection

    # optional
    connection_detail:
      # optional
      enc_properties: null
      key: key_example
      description: description_example
      display_name: display_name_example
      time_created: time_created_example
      time_updated: time_updated_example
      created_by_id: "ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx"
      updated_by_id: "ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx"
      custom_property_members:
      - # optional
        key: key_example
        display_name: display_name_example
        description: description_example
        value: value_example
        data_type: TEXT
        namespace_name: namespace_name_example
        namespace_key: namespace_key_example
        is_multi_valued: true
        is_hidden: true
        is_editable: true
        is_shown_in_list: true
        is_event_enabled: true
        is_list_type: true
        allowed_values: [ "allowed_values_example" ]
      properties: null
      external_key: external_key_example
      time_status_updated: time_status_updated_example
      lifecycle_state: CREATING
      is_default: true
      data_asset_key: data_asset_key_example
      type_key: type_key_example
      uri: uri_example

- name: Perform action import_data_asset on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    import_file_contents: import_file_contents_example
    import_type: [ "CUSTOM_PROPERTY_VALUES" ]
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    action: import_data_asset

    # optional
    is_missing_value_ignored: true

- name: Perform action parse_connection on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    action: parse_connection

    # optional
    wallet_secret_id: "ocid1.walletsecret.oc1..xxxxxxEXAMPLExxxxxx"
    wallet_secret_name: wallet_secret_name_example
    connection_key: connection_key_example
    connection_detail:
      # optional
      enc_properties: null
      key: key_example
      description: description_example
      display_name: display_name_example
      time_created: time_created_example
      time_updated: time_updated_example
      created_by_id: "ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx"
      updated_by_id: "ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx"
      custom_property_members:
      - # optional
        key: key_example
        display_name: display_name_example
        description: description_example
        value: value_example
        data_type: TEXT
        namespace_name: namespace_name_example
        namespace_key: namespace_key_example
        is_multi_valued: true
        is_hidden: true
        is_editable: true
        is_shown_in_list: true
        is_event_enabled: true
        is_list_type: true
        allowed_values: [ "allowed_values_example" ]
      properties: null
      external_key: external_key_example
      time_status_updated: time_status_updated_example
      lifecycle_state: CREATING
      is_default: true
      data_asset_key: data_asset_key_example
      type_key: type_key_example
      uri: uri_example
    connection_payload: connection_payload_example

- name: Perform action remove_data_selector_patterns on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    items: [ "items_example" ]
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    action: remove_data_selector_patterns

- name: Perform action synchronous_export on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    dest: /tmp/myfile
    export_type: [ "CUSTOM_PROPERTY_VALUES" ]
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    action: synchronous_export

    # optional
    export_scope:
    - # optional
      object_key: object_key_example
      export_type_ids: [ "export_type_ids_example" ]

- name: Perform action validate_connection on data_asset
  oci_data_catalog_data_asset_actions:
    # required
    catalog_id: "ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx"
    data_asset_key: data_asset_key_example
    action: validate_connection

    # optional
    connection_detail:
      # optional
      enc_properties: null
      key: key_example
      description: description_example
      display_name: display_name_example
      time_created: time_created_example
      time_updated: time_updated_example
      created_by_id: "ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx"
      updated_by_id: "ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx"
      custom_property_members:
      - # optional
        key: key_example
        display_name: display_name_example
        description: description_example
        value: value_example
        data_type: TEXT
        namespace_name: namespace_name_example
        namespace_key: namespace_key_example
        is_multi_valued: true
        is_hidden: true
        is_editable: true
        is_shown_in_list: true
        is_event_enabled: true
        is_list_type: true
        allowed_values: [ "allowed_values_example" ]
      properties: null
      external_key: external_key_example
      time_status_updated: time_status_updated_example
      lifecycle_state: CREATING
      is_default: true
      data_asset_key: data_asset_key_example
      type_key: type_key_example
      uri: uri_example
    connection_payload: connection_payload_example

Return Values

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

Key Returned Description
data_asset
complex
on success
Details of the DataAsset resource acted upon by the current operation

Sample:
{'catalog_id': 'ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx', 'created_by_id': 'ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx', 'custom_property_members': [{'allowed_values': [], 'data_type': 'TEXT', 'description': 'description_example', 'display_name': 'display_name_example', 'is_editable': True, 'is_event_enabled': True, 'is_hidden': True, 'is_list_type': True, 'is_multi_valued': True, 'is_shown_in_list': True, 'key': 'key_example', 'namespace_key': 'namespace_key_example', 'namespace_name': 'namespace_name_example', 'value': 'value_example'}], 'data_selector_patterns': [{'catalog_id': 'ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'display_name': 'display_name_example', 'expression': 'expression_example', 'file_path_prefix': 'file_path_prefix_example', 'key': 'key_example', 'lifecycle_state': 'CREATING', 'time_created': '2013-10-20T19:20:30+01:00'}], 'description': 'description_example', 'display_name': 'display_name_example', 'external_key': 'external_key_example', 'key': 'key_example', 'lifecycle_state': 'CREATING', 'properties': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_harvested': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type_key': 'type_key_example', 'updated_by_id': 'ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx', 'uri': 'uri_example'}
 
catalog_id
string
on success
The data catalog's OCID.

Sample:
ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx
 
created_by_id
string
on success
OCID of the user who created the data asset.

Sample:
ocid1.createdby.oc1..xxxxxxEXAMPLExxxxxx
 
custom_property_members
complex
on success
The list of customized properties along with the values for this object
   
allowed_values
list / elements=string
on success
Allowed values for the custom property if any
   
data_type
string
on success
The data type of the custom property

Sample:
TEXT
   
description
string
on success
Description of the custom property

Sample:
description_example
   
display_name
string
on success
Display name of the custom property

Sample:
display_name_example
   
is_editable
boolean
on success
If this field is a editable field

Sample:
True
   
is_event_enabled
boolean
on success
If an OCI Event will be emitted when the custom property is modified.

Sample:
True
   
is_hidden
boolean
on success
If this field is a hidden field

Sample:
True
   
is_list_type
boolean
on success
Is this property allowed to have list of values

Sample:
True
   
is_multi_valued
boolean
on success
If this field allows multiple values to be set

Sample:
True
   
is_shown_in_list
boolean
on success
If this field is displayed in a list view of applicable objects.

Sample:
True
   
key
string
on success
Unique Identifier of the attribute which is ID

Sample:
key_example
   
namespace_key
string
on success
Unique namespace key that is immutable

Sample:
namespace_key_example
   
namespace_name
string
on success
Namespace name of the custom property

Sample:
namespace_name_example
   
value
string
on success
The custom property value

Sample:
value_example
 
data_selector_patterns
complex
on success
The list of data selector patterns used in the harvest for this data asset to derive logical entities.
   
catalog_id
string
on success
The data catalog's OCID.

Sample:
ocid1.catalog.oc1..xxxxxxEXAMPLExxxxxx
   
description
string
on success
Detailed description of the pattern.

Sample:
description_example
   
display_name
string
on success
A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
   
expression
string
on success
Input string which drives the selection process, allowing for fine-grained control using qualifiers. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.

Sample:
expression_example
   
file_path_prefix
string
on success
Input string which drives the selection process. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.

Sample:
file_path_prefix_example
   
key
string
on success
Unique pattern key that is immutable.

Sample:
key_example
   
lifecycle_state
string
on success
State of the pattern.

Sample:
CREATING
   
time_created
string
on success
The date and time the pattern was created, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
description
string
on success
Detailed description of the data asset.

Sample:
description_example
 
display_name
string
on success
A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
external_key
string
on success
External URI that can be used to reference the object. Format will differ based on the type of object.

Sample:
external_key_example
 
key
string
on success
Unique data asset key that is immutable.

Sample:
key_example
 
lifecycle_state
string
on success
The current state of the data asset.

Sample:
CREATING
 
properties
dictionary
on success
A map of maps that contains the properties which are specific to the asset type. Each data asset type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most data assets have required properties within the "default" category. Example: `{"properties": { "default": { "host": "host1", "port": "1521", "database": "orcl"}}}`
 
time_created
string
on success
The date and time the data asset was created, in the format defined by RFC3339. Example: `2019-03-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_harvested
string
on success
The last time that a harvest was performed on the data asset. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The last time that any change was made to the data asset. An RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
type_key
string
on success
The key of the object type. Type key's can be found via the '/types' endpoint.

Sample:
type_key_example
 
updated_by_id
string
on success
OCID of the user who last modified the data asset.

Sample:
ocid1.updatedby.oc1..xxxxxxEXAMPLExxxxxx
 
uri
string
on success
URI to the data asset instance in the API.

Sample:
uri_example


Authors

  • Oracle (@oracle)