oracle.oci.oci_data_connectivity_data_entity_actions – Perform actions on a DataEntity resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DataEntity resource in Oracle Cloud Infrastructure

  • For action=create_entity_shape, creates the data entity shape using the shape from the data asset.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • create_entity_shape
The action to perform on the DataEntity.
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.
authorization_mode
string
    Choices:
  • OBO
  • USER_PRINCIPAL
  • RESOURCE_PRINCIPAL
  • INSTANCE_PRINCIPAL
  • UNDEFINED
Authorization mode for communicating with another OCI service relevant for the API.
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_format
dictionary
Applicable when model_type is one of ['FILE_ENTITY', 'MESSAGE_ENTITY']
compression_config
dictionary
Applicable when model_type is 'MESSAGE_ENTITY'
codec
string / required
    Choices:
  • NONE
  • AUTO
  • GZIP
  • BZIP2
  • DEFLATE
  • LZ4
  • SNAPPY
Compression algorithm
Required when model_type is 'MESSAGE_ENTITY'
format_attribute
dictionary
Applicable when model_type is 'MESSAGE_ENTITY'
compression
string
The compression for the file.
Applicable when model_type is one of ['PARQUET_FORMAT', 'AVRO_FORMAT']
data_address
string
Range of the data. For example, "'My Sheet'!B3:C35"
Applicable when model_type is 'EXCEL_FORMAT'
delimiter
string
The delimiter for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
encoding
string
The encoding for the file.
Applicable when model_type is one of ['CSV_FORMAT', 'JSON_FORMAT']
escape_character
string
The escape character for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
has_header
boolean
    Choices:
  • no
  • yes
Defines whether the file has a header row.
Applicable when model_type is 'CSV_FORMAT'
header
boolean
    Choices:
  • no
  • yes
Whether the dataAddress contains the header with column names. If false - column names fill be generated.
Applicable when model_type is 'EXCEL_FORMAT'
is_file_pattern
boolean
    Choices:
  • no
  • yes
Defines whether a file pattern is supported.
Applicable when model_type is 'CSV_FORMAT'
is_multiline
boolean
    Choices:
  • no
  • yes
Defines whether the file has a multiline content
Applicable when model_type is 'CSV_FORMAT'
is_quote_all
boolean
    Choices:
  • no
  • yes
Defines whether the quote entire content while performing read/write.
Applicable when model_type is 'CSV_FORMAT'
is_trailing_delimiter
boolean
    Choices:
  • no
  • yes
Defines whether the file has a trailing delimiter
Applicable when model_type is 'CSV_FORMAT'
model_type
string / required
    Choices:
  • AVRO_FORMAT
  • JSON_FORMAT
  • CSV_FORMAT
  • PARQUET_FORMAT
  • EXCEL_FORMAT
The type of the format attribute.
password
string
Workbook password if it is password protected.
Applicable when model_type is 'EXCEL_FORMAT'
quote_character
string
The quote character for the CSV format.
Applicable when model_type is 'CSV_FORMAT'
timestamp_format
string
Format for timestamp information.
Applicable when model_type is 'CSV_FORMAT'
type
string / required
    Choices:
  • JSON
  • CSV
  • PARQUET
  • AVRO
type
Required when model_type is 'MESSAGE_ENTITY'
endpoint_id
string
Endpoint ID used for getDataAssetFullDetails.
entity_properties
dictionary
Map<String, String> for entity properties
entity_type
string
    Choices:
  • TABLE
  • VIEW
  • FILE
  • SQL
  • DATA_STORE
  • MESSAGE
The entity type.
external_key
string
The external key of the object.
foreign_keys
list / elements=dictionary
An array of foreign keys.
attribute_refs
list / elements=dictionary
An array of attribute references.
Applicable when model_type is 'DATA_STORE_ENTITY'
attribute
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
config_values
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
config_param_values
dictionary
The configuration parameter values.
Applicable when model_type is 'DATA_STORE_ENTITY'
int_value
integer
An integer value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_value
dictionary
An object value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
parameter_value
string
Reference to the parameter by its key.
Applicable when model_type is 'DATA_STORE_ENTITY'
ref_value
dictionary
The root object reference value.
Applicable when model_type is 'DATA_STORE_ENTITY'
string_value
string
A string value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
description
string
A detailed description of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
key
string
The key of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
labels
list / elements=string
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
Required when model_type is 'DATA_STORE_ENTITY'
model_version
string
The model version of an object.
Applicable when model_type is 'DATA_STORE_ENTITY'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'DATA_STORE_ENTITY'
native_shape_field
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
config_values
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
config_param_values
dictionary
The configuration parameter values.
Applicable when model_type is 'DATA_STORE_ENTITY'
int_value
integer
An integer value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_value
dictionary
An object value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
parameter_value
string
Reference to the parameter by its key.
Applicable when model_type is 'DATA_STORE_ENTITY'
ref_value
dictionary
The root object reference value.
Applicable when model_type is 'DATA_STORE_ENTITY'
string_value
string
A string value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
default_value_string
string
The default value.
Applicable when model_type is 'DATA_STORE_ENTITY'
description
string
A detailed description of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies whether the field is mandatory.
Applicable when model_type is 'DATA_STORE_ENTITY'
key
string
The key of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
Required when model_type is 'DATA_STORE_ENTITY'
model_version
string
The model version of an object.
Applicable when model_type is 'DATA_STORE_ENTITY'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
position
integer
The position of the attribute.
Applicable when model_type is 'DATA_STORE_ENTITY'
type
dictionary / required
The type reference.
Required when model_type is 'DATA_STORE_ENTITY'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
type
dictionary
The type reference.
Applicable when model_type is 'DATA_STORE_ENTITY'
position
integer
The position of the attribute.
Applicable when model_type is 'DATA_STORE_ENTITY'
delete_rule
integer
The delete rule.
Applicable when model_type is 'DATA_STORE_ENTITY'
key
string
The object key.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_type
string / required
    Choices:
  • FOREIGN_KEY
The key type.
Required when model_type is 'DATA_STORE_ENTITY'
model_version
string
The model version of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
reference_unique_key
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
attribute_refs
list / elements=dictionary
An array of attribute references.
attribute
dictionary
config_values
dictionary
config_param_values
dictionary
The configuration parameter values.
int_value
integer
An integer value of the parameter.
object_value
dictionary
An object value of the parameter.
parameter_value
string
Reference to the parameter by its key.
ref_value
dictionary
The root object reference value.
string_value
string
A string value of the parameter.
parent_ref
dictionary
parent
string
Key of the parent object.
description
string
A detailed description of the object.
key
string
The key of the object.
labels
list / elements=string
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
native_shape_field
dictionary
config_values
dictionary
config_param_values
dictionary
The configuration parameter values.
int_value
integer
An integer value of the parameter.
object_value
dictionary
An object value of the parameter.
parameter_value
string
Reference to the parameter by its key.
ref_value
dictionary
The root object reference value.
string_value
string
A string value of the parameter.
parent_ref
dictionary
parent
string
Key of the parent object.
default_value_string
string
The default value.
description
string
A detailed description of the object.
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies whether the field is mandatory.
key
string
The key of the object.
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.
position
integer
The position of the attribute.
type
dictionary / required
The type reference.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.
type
dictionary
The type reference.
position
integer
The position of the attribute.
key
string
The object key.
model_type
string / required
    Choices:
  • PRIMARY_KEY
The key type.
model_version
string
The model version of the object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.
update_rule
integer
The update rule.
Applicable when model_type is 'DATA_STORE_ENTITY'
identifier
string
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
key
string
The object key.
model_type
string / required
    Choices:
  • DATA_STORE_ENTITY
  • MESSAGE_ENTITY
  • TABLE_ENTITY
  • SQL_ENTITY
  • FILE_ENTITY
  • VIEW_ENTITY
The data entity type.
model_version
string
The model version of the object.
name
string / required
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
object_version
integer
The version of the object that is used to track changes in the object instance.
other_type_label
string
Specifies other type label.
parent_ref
dictionary
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
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.
resource_name
string
The resource name.
schema_resource_name
string / required
The schema resource name used for retrieving schemas.
shape
dictionary
config_values
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
config_param_values
dictionary
The configuration parameter values.
Applicable when model_type is 'DATA_STORE_ENTITY'
int_value
integer
An integer value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_value
dictionary
An object value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
parameter_value
string
Reference to the parameter by its key.
Applicable when model_type is 'DATA_STORE_ENTITY'
ref_value
dictionary
The root object reference value.
Applicable when model_type is 'DATA_STORE_ENTITY'
string_value
string
A string value of the parameter.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
description
string
A detailed description of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
key
string
The key of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
Required when model_type is 'DATA_STORE_ENTITY'
model_version
string
The model version of an object.
Applicable when model_type is 'DATA_STORE_ENTITY'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
type
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
config_definition
dictionary
Applicable when model_type is one of ['DATA_TYPE', 'CONFIGURED_TYPE', 'COMPOSITE_TYPE']
config_parameter_definitions
dictionary
The parameter configuration details.
Applicable when model_type is 'CONFIGURED_TYPE'
class_field_name
string
The parameter class field name.
Applicable when model_type is 'CONFIGURED_TYPE'
default_value
dictionary
The default value for the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
description
string
A user-defined description for the object.
Applicable when model_type is 'CONFIGURED_TYPE'
is_class_field_value
boolean
    Choices:
  • no
  • yes
Specifies whether the parameter is a class field.
Applicable when model_type is 'CONFIGURED_TYPE'
is_static
boolean
    Choices:
  • no
  • yes
Specifies whether the parameter is static.
Applicable when model_type is 'CONFIGURED_TYPE'
parameter_name
string
This object represents the configurable properties for an object type.
Applicable when model_type is 'CONFIGURED_TYPE'
parameter_type
dictionary
Applicable when model_type is 'CONFIGURED_TYPE'
description
string
A user-defined description for the object.
key
string
The key of the object.
model_type
string / required
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
The property which differentiates the subtypes.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
is_contained
boolean
    Choices:
  • no
  • yes
Specifies whether the configuration is contained.
Applicable when model_type is 'CONFIGURED_TYPE'
key
string
The key of the object.
Applicable when model_type is 'CONFIGURED_TYPE'
model_type
string
The type of the object.
Applicable when model_type is 'CONFIGURED_TYPE'
model_version
string
The model version of an object.
Applicable when model_type is 'CONFIGURED_TYPE'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'CONFIGURED_TYPE'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'CONFIGURED_TYPE'
parent_ref
dictionary
Applicable when model_type is 'CONFIGURED_TYPE'
parent
string
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
config_values
dictionary
Applicable when model_type is 'CONFIGURED_TYPE'
config_param_values
dictionary
The configuration parameter values.
Applicable when model_type is 'CONFIGURED_TYPE'
int_value
integer
An integer value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
object_value
dictionary
An object value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
parameter_value
string
Reference to the parameter by its key.
Applicable when model_type is 'CONFIGURED_TYPE'
ref_value
dictionary
The root object reference value.
Applicable when model_type is 'CONFIGURED_TYPE'
string_value
string
A string value of the parameter.
Applicable when model_type is 'CONFIGURED_TYPE'
parent_ref
dictionary
Applicable when model_type is 'CONFIGURED_TYPE'
parent
string
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
description
string
A user-defined description for the object.
dt_type
string
    Choices:
  • PRIMITIVE
  • STRUCTURED
The data type.
Applicable when model_type is 'DATA_TYPE'
elements
list / elements=dictionary
An array of elements.
Applicable when model_type is 'COMPOSITE_TYPE'
config_values
dictionary
config_param_values
dictionary
The configuration parameter values.
Applicable when model_type is 'OUTPUT_PORT'
int_value
integer
An integer value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
object_value
dictionary
An object value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
parameter_value
string
Reference to the parameter by its key.
Applicable when model_type is 'OUTPUT_PORT'
ref_value
dictionary
The root object reference value.
Applicable when model_type is 'OUTPUT_PORT'
string_value
string
A string value of the parameter.
Applicable when model_type is 'OUTPUT_PORT'
parent_ref
dictionary
Applicable when model_type is 'OUTPUT_PORT'
parent
string
Key of the parent object.
Applicable when model_type is 'OUTPUT_PORT'
default_value
dictionary
The default value of the parameter.
Applicable when model_type is 'PARAMETER'
default_value_string
string
The default value.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
description
string
A detailed description of the object.
fields
list / elements=dictionary
An array of fields.
Applicable when model_type is one of ['INPUT_PORT', 'OUTPUT_PORT']
config_values
dictionary
description
string
A detailed description of the object.
key
string
The key of the object.
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
is_input
boolean
    Choices:
  • no
  • yes
Specifies whether the parameter is an input value.
Applicable when model_type is 'PARAMETER'
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies whether the field is mandatory.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
is_output
boolean
    Choices:
  • no
  • yes
Specifies whether the parameter is an output value.
Applicable when model_type is 'PARAMETER'
key
string
The key of the object.
labels
list / elements=string
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
Applicable when model_type is 'SHAPE_FIELD'
model_type
string / required
    Choices:
  • OUTPUT_PORT
  • SHAPE
  • SHAPE_FIELD
  • INPUT_PORT
  • PARAMETER
  • NATIVE_SHAPE_FIELD
The type of the types object.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
native_shape_field
dictionary
Applicable when model_type is 'SHAPE_FIELD'
config_values
dictionary
Applicable when model_type is 'SHAPE_FIELD'
config_param_values
dictionary
The configuration parameter values.
Applicable when model_type is 'SHAPE_FIELD'
int_value
integer
An integer value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
object_value
dictionary
An object value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
parameter_value
string
Reference to the parameter by its key.
Applicable when model_type is 'SHAPE_FIELD'
ref_value
dictionary
The root object reference value.
Applicable when model_type is 'SHAPE_FIELD'
string_value
string
A string value of the parameter.
Applicable when model_type is 'SHAPE_FIELD'
parent_ref
dictionary
Applicable when model_type is 'SHAPE_FIELD'
parent
string
Key of the parent object.
Applicable when model_type is 'SHAPE_FIELD'
default_value_string
string
The default value.
Applicable when model_type is 'SHAPE_FIELD'
description
string
A detailed description of the object.
Applicable when model_type is 'SHAPE_FIELD'
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies whether the field is mandatory.
Applicable when model_type is 'SHAPE_FIELD'
key
string
The key of the object.
Applicable when model_type is 'SHAPE_FIELD'
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
Required when model_type is 'SHAPE_FIELD'
model_version
string
The model version of an object.
Applicable when model_type is 'SHAPE_FIELD'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'SHAPE_FIELD'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'SHAPE_FIELD'
parent_ref
dictionary
Applicable when model_type is 'SHAPE_FIELD'
parent
string
Key of the parent object.
Applicable when model_type is 'SHAPE_FIELD'
position
integer
The position of the attribute.
Applicable when model_type is 'SHAPE_FIELD'
type
dictionary / required
The type reference.
Required when model_type is 'SHAPE_FIELD'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
output_aggregation_type
string
    Choices:
  • MIN
  • MAX
  • COUNT
  • SUM
The output aggregation type.
Applicable when model_type is 'PARAMETER'
parent_ref
dictionary
parent
string
Key of the parent object.
Applicable when model_type is 'OUTPUT_PORT'
port_type
string
    Choices:
  • DATA
  • CONTROL
  • MODEL
The port details of the data asset type.
Applicable when model_type is one of ['INPUT_PORT', 'OUTPUT_PORT']
position
integer
The position of the attribute.
Applicable when model_type is 'NATIVE_SHAPE_FIELD'
root_object_default_value
dictionary
The default value of the parameter, which can be an object in DIS, such as a data entity.
Applicable when model_type is 'PARAMETER'
type
dictionary
Applicable when model_type is one of ['SHAPE', 'SHAPE_FIELD', 'PARAMETER']
Required when model_type is 'NATIVE_SHAPE_FIELD'
description
string
A user-defined description for the object.
key
string
The key of the object.
model_type
string
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
The property which differentiates the subtypes.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
type_name
string
The type of value the parameter was created for.
Applicable when model_type is 'PARAMETER'
key
string
The key of the object.
model_type
string / required
    Choices:
  • CONFIGURED_TYPE
  • DERIVED_TYPE
  • DATA_TYPE
  • STRUCTURED_TYPE
  • COMPOSITE_TYPE
The property which differentiates the subtypes.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.
Applicable when model_type is 'CONFIGURED_TYPE'
parent_type
dictionary
Applicable when model_type is 'COMPOSITE_TYPE'
config_definition
dictionary
description
string
A user-defined description for the object.
elements
list / elements=dictionary
An array of elements.
key
string
The key of the object.
model_type
string / required
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
The property which differentiates the subtypes.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent_type
dictionary
schema
dictionary
Applicable when model_type is 'STRUCTURED_TYPE'
description
string
A user-defined description for the object.
key
string
The key of the object.
model_type
string / required
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
The property which differentiates the subtypes.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
type_system_name
string
The data type system name.
Applicable when model_type is 'DATA_TYPE'
wrapped_type
dictionary
Applicable when model_type is 'CONFIGURED_TYPE'
description
string
A user-defined description for the object.
key
string
The key of the object.
model_type
string / required
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
The property which differentiates the subtypes.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
shape_id
string
The shape ID.
sql_query
string
sqlQuery
Applicable when model_type is 'SQL_ENTITY'
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
types
dictionary
description
string
A user defined description for the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
identifier
string
Value can only contain upper case letters, underscore, and numbers. It should begin with an upper case letter or underscore. The value can be modified.
Applicable when model_type is 'DATA_STORE_ENTITY'
key
string
The key of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_type
string
The type of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_version
string
The model version of an object.
Applicable when model_type is 'DATA_STORE_ENTITY'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_version
integer
The version of the object that is used to track changes in the object instance.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
types
dictionary
types
Applicable when model_type is 'DATA_STORE_ENTITY'
description
string
A user-defined description for the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
key
string
The key of the object.
Applicable when model_type is 'DATA_STORE_ENTITY'
model_type
string / required
    Choices:
  • STRUCTURED_TYPE
  • DATA_TYPE
  • CONFIGURED_TYPE
  • COMPOSITE_TYPE
  • DERIVED_TYPE
The property which differentiates the subtypes.
Required when model_type is 'DATA_STORE_ENTITY'
model_version
string
The model version of an object.
Applicable when model_type is 'DATA_STORE_ENTITY'
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
Applicable when model_type is 'DATA_STORE_ENTITY'
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Applicable when model_type is 'DATA_STORE_ENTITY'
parent_ref
dictionary
Applicable when model_type is 'DATA_STORE_ENTITY'
parent
string
Key of the parent object.
Applicable when model_type is 'DATA_STORE_ENTITY'
unique_keys
list / elements=dictionary
An array of unique keys.
attribute_refs
list / elements=dictionary
An array of attribute references.
attribute
dictionary
config_values
dictionary
config_param_values
dictionary
The configuration parameter values.
int_value
integer
An integer value of the parameter.
object_value
dictionary
An object value of the parameter.
parameter_value
string
Reference to the parameter by its key.
ref_value
dictionary
The root object reference value.
string_value
string
A string value of the parameter.
parent_ref
dictionary
parent
string
Key of the parent object.
description
string
A detailed description of the object.
key
string
The key of the object.
labels
list / elements=string
Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
native_shape_field
dictionary
config_values
dictionary
config_param_values
dictionary
The configuration parameter values.
int_value
integer
An integer value of the parameter.
object_value
dictionary
An object value of the parameter.
parameter_value
string
Reference to the parameter by its key.
ref_value
dictionary
The root object reference value.
string_value
string
A string value of the parameter.
parent_ref
dictionary
parent
string
Key of the parent object.
default_value_string
string
The default value.
description
string
A detailed description of the object.
is_mandatory
boolean
    Choices:
  • no
  • yes
Specifies whether the field is mandatory.
key
string
The key of the object.
model_type
string / required
    Choices:
  • SHAPE
  • SHAPE_FIELD
  • NATIVE_SHAPE_FIELD
The type of the types object.
model_version
string
The model version of an object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.
position
integer
The position of the attribute.
type
dictionary / required
The type reference.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.
type
dictionary
The type reference.
position
integer
The position of the attribute.
key
string
The object key.
model_type
string / required
    Choices:
  • PRIMARY_KEY
The key type.
model_version
string
The model version of the object.
name
string
Free form text without any restriction on the permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.
object_status
integer
The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
parent_ref
dictionary
parent
string
Key of the parent object.

Examples

- name: Perform action create_entity_shape on data_entity with model_type = DATA_STORE_ENTITY
  oci_data_connectivity_data_entity_actions:
    # required
    model_type: DATA_STORE_ENTITY
    name: name_example

    # optional
    key: key_example
    model_version: model_version_example
    parent_ref:
      # optional
      parent: parent_example
    object_version: 56
    external_key: external_key_example
    shape:
      # required
      model_type: SHAPE

      # optional
      key: key_example
      model_version: model_version_example
      parent_ref:
        # optional
        parent: parent_example
      config_values:
        # optional
        config_param_values:
          # optional
          string_value: string_value_example
          int_value: 56
          object_value: null
          ref_value: null
          parameter_value: parameter_value_example
        parent_ref:
          # optional
          parent: parent_example
      object_status: 56
      name: name_example
      description: description_example
      type:
        # required
        model_type: CONFIGURED_TYPE

        # optional
        wrapped_type:
          # required
          model_type: STRUCTURED_TYPE

          # optional
          key: key_example
          model_version: model_version_example
          parent_ref: null
          name: name_example
          object_status: 56
          description: description_example
        config_values:
          # optional
          config_param_values:
            # optional
            string_value: string_value_example
            int_value: 56
            object_value: null
            ref_value: null
            parameter_value: parameter_value_example
          parent_ref:
            # optional
            parent: parent_example
        key: key_example
        model_version: model_version_example
        parent_ref:
          # optional
          parent: parent_example